Skip to main content
PATCH
/
1
/
providers
/
{providerId}
curl
curl --request PATCH \
  --url https://example.algolia.net/agent-studio/1/providers/lorem \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '
{
  "name": "lorem",
  "input": {
    "apiKey": "lorem",
    "baseUrl": "lorem"
  }
}
'
{
  "createdAt": "<string>",
  "id": "<string>",
  "input": {
    "apiKey": "<string>",
    "baseUrl": "<string>"
  },
  "name": "<string>",
  "providerName": "<string>",
  "updatedAt": "<string>",
  "lastUsedAt": "<string>"
}
Required ACL: editSettings

Authorizations

x-algolia-application-id
string
header
required

Your Algolia application ID.

x-algolia-api-key
string
header
required

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.

Path Parameters

providerId
string
required

The providerId.

Body

application/json
input
openAIProviderInput · object

OpenAI-specific provider input.

name
string | null
Required string length: 1 - 128

Response

Successful Response.

createdAt
string
required
id
string
required
input
openAIProviderInput · object
required

OpenAI-specific provider input.

name
string
required
providerName
string
required
updatedAt
string
required
lastUsedAt
string | null
Last modified on June 11, 2026