> ## Documentation Index > Fetch the complete documentation index at: https://algolia.com/llms.txt > Use this file to discover all available pages before exploring further. # List Providers > List Providers. This is a **beta feature** according to [Algolia's Terms of Service ("Beta Services")](https://www.algolia.com/policies/terms/). **Required ACL:** `settings` ## OpenAPI ````yaml specs/agent-studio.yml get /1/providers openapi: 3.1.0 info: title: Agent Studio API description: > The Agent Studio API lets you build and operate generative AI agents that use Algolia data, tools, and your chosen LLM provider. Use it to create, configure, publish, and update agents, then generate chat completions grounded in live data from your Algolia indices. You can manage LLM providers, Agent Studio tools, conversations, feedback, secret keys, user data, caching, and application settings for your AI experiences. ## Client libraries Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. For more information, see [Algolia's ecosystem](https://www.algolia.com/doc/libraries). ## Base URL Base URL for the Agent Studio API: - `https://{APPLICATION_ID}.algolia.net/agent-studio` **All requests must use HTTPS.** ## Authentication Add these headers to authenticate requests: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account/api-keys). ## Request format Request bodies must be JSON objects. ## Response status and errors The Agent Studio API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses return `2xx` statuses. Client errors return `4xx` statuses. Server errors return `5xx` statuses. Error responses have a `message` property with more information. ## Version The current version of the Agent Studio API is version 1, indicated by the `/1/` in each endpoint's URL. version: 0.1.0 servers: - url: https://{APPLICATION_ID}.algolia.net/agent-studio description: Agent Studio API. variables: APPLICATION_ID: default: EXAMPLE description: Your Algolia application ID. security: - appId: [] apiKey: [] tags: - name: Agents description: Manage your agents. - name: Allowed Domains description: Restrict where an agent's API key may be used. - name: Completions description: Generate completions. - name: Configurations description: Manage Agent Studio related application configurations. - name: Conversations description: View, export, and delete conversation history. - name: Feedback description: Capture user feedback on agent responses. - name: Internal description: Endpoints that are needed for internal or integration logic. - name: Providers description: Manage your LLM providers. - name: Secret Keys description: Manage secret keys used to authenticate requests. - name: User Data description: Manage end-user data associated with conversations. paths: /1/providers: get: tags: - Providers summary: List Providers description: List Providers. operationId: listProviders parameters: - name: limit in: query required: false schema: type: integer minimum: 1 description: Items per page. default: 10 title: limit description: Items per page. - name: page in: query required: false schema: type: integer minimum: 1 description: Page number. default: 1 title: page description: Page number. responses: '200': description: Successful Response. content: application/json: schema: $ref: '#/components/schemas/PaginatedProviderAuthenticationsResponse' '422': description: Validation Error. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-codeSamples: - lang: csharp label: C# source: |- // Initialize the client var client = new AgentStudioClient( new AgentStudioConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") ); // Call the API var response = await client.ListProvidersAsync(); // print the response Console.WriteLine(response); - lang: dart label: Dart source: |- // Initialize the client final client = AgentStudioClient( appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY'); // Call the API final response = await client.listProviders(); // print the response print(response); - lang: go label: Go source: >- // Initialize the client client, err := agentStudio.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") if err != nil { // The client can fail to initialize if you pass an invalid parameter. panic(err) } // Call the API response, err := client.ListProviders(client.NewApiListProvidersRequest()) if err != nil { // handle the eventual error panic(err) } // print the response print(response) - lang: java label: Java source: >- // Initialize the client AgentStudioClient client = new AgentStudioClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"); // Call the API PaginatedProviderAuthenticationsResponse response = client.listProviders(); // print the response System.out.println(response); - lang: javascript label: JavaScript source: >- // Initialize the client const client = agentStudioClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY'); // Call the API const response = await client.listProviders(); // print the response console.log(response); - lang: kotlin label: Kotlin source: >- // Initialize the client val client = AgentStudioClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY") // Call the API var response = client.listProviders() // print the response println(response) - lang: php label: PHP source: >- // Initialize the client $client = AgentStudioClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY'); // Call the API $response = $client->listProviders(); // print the response var_dump($response); - lang: python label: Python source: >- # Initialize the client # In an asynchronous context, you can use AgentStudioClient instead, which exposes the exact same methods. client = AgentStudioClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") # Call the API response = client.list_providers() # print the response print(response) - lang: ruby label: Ruby source: >- # Initialize the client client = Algolia::AgentStudioClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") # Call the API response = client.list_providers # print the response puts(response) - lang: scala label: Scala source: >- // Initialize the client val client = AgentStudioClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY") // Call the API val response = Await.result( client.listProviders( ), Duration(100, "sec") ) // print the response println(response) - lang: swift label: Swift source: >- // Initialize the client let client = try AgentStudioClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY") // Call the API let response = try await client.listProviders() // print the response print(response) - lang: cURL label: curl source: |- curl --request GET \ --url 'https://example.algolia.net/agent-studio/1/providers?page=1&limit=10' \ --header 'accept: application/json' \ --header 'x-algolia-api-key: ALGOLIA_API_KEY' \ --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' components: schemas: PaginatedProviderAuthenticationsResponse: properties: data: items: $ref: '#/components/schemas/ProviderAuthenticationResponse' type: array title: data pagination: $ref: '#/components/schemas/PaginationMetadata' type: object required: - data - pagination title: paginatedProviders HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: detail type: object title: hTTPValidationError ProviderAuthenticationResponse: properties: createdAt: type: string title: createdat id: type: string title: id input: $ref: '#/components/schemas/ProviderInput' name: type: string title: name providerName: type: string title: providername updatedAt: type: string title: updatedat lastUsedAt: oneOf: - type: string - type: 'null' title: lastusedat type: object required: - id - name - providerName - input - createdAt - updatedAt title: provider PaginationMetadata: properties: limit: type: integer title: limit page: type: integer title: page totalCount: type: integer title: totalcount totalPages: type: integer title: totalpages type: object required: - page - limit - totalCount - totalPages title: paginationMetadata ValidationError: properties: loc: items: $ref: '#/components/schemas/LocationItemUnion' type: array title: location msg: type: string title: message type: type: string title: errorType ctx: type: object title: context input: title: input type: object required: - loc - msg - type title: validationError ProviderInput: oneOf: - $ref: '#/components/schemas/OpenAIProviderInput' - $ref: '#/components/schemas/AzureOpenAIProviderInput' - $ref: '#/components/schemas/OpenAICompatibleProviderInput' - $ref: '#/components/schemas/BaseProviderInput' - $ref: '#/components/schemas/AnthropicProviderInput' LocationItemUnion: oneOf: - type: string - type: integer OpenAIProviderInput: properties: apiKey: type: string title: apikey baseUrl: oneOf: - type: string maxLength: 2083 minLength: 1 - type: 'null' title: baseurl type: object required: - apiKey title: openAIProviderInput description: OpenAI-specific provider input. AzureOpenAIProviderInput: properties: apiKey: type: string title: apikey azureDeployment: type: string minLength: 1 title: azuredeployment description: Azure model deployment name is required. azureEndpoint: type: string maxLength: 2083 minLength: 1 title: azureendpoint apiVersion: oneOf: - type: string - type: 'null' title: apiversion default: 2024-12-01-preview type: object required: - apiKey - azureEndpoint - azureDeployment title: azureOpenAIProviderInput description: Azure OpenAI-specific provider input. OpenAICompatibleProviderInput: properties: apiKey: type: string title: apikey baseUrl: type: string maxLength: 2083 minLength: 1 title: baseurl defaultModel: type: string minLength: 1 title: defaultmodel description: >- Default model for this provider. Used for validation and as fallback when no model is specified at agent level. type: object required: - apiKey - baseUrl - defaultModel title: openAICompatibleProviderInput description: >- OpenAI-compatible provider input. Contrary to the OpenAIProviderInput, the base_url is required. A model is required to verify connectivity and get saved as the default model. This can later be changed at the Agent level. BaseProviderInput: properties: apiKey: type: string title: apikey type: object required: - apiKey title: baseProviderInput description: Base input that all providers must have. AnthropicProviderInput: properties: apiKey: type: string title: apikey baseUrl: oneOf: - type: string maxLength: 2083 minLength: 1 - type: 'null' title: baseurl type: object required: - apiKey title: anthropicProviderInput description: Anthropic-specific provider input. securitySchemes: appId: type: apiKey in: header name: x-algolia-application-id description: Your Algolia application ID. apiKey: type: apiKey in: header name: x-algolia-api-key description: > Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference. ````