> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Patch Secret Key
> Patch Secret Key.
This is a **beta feature** according to [Algolia's Terms of Service ("Beta Services")](https://www.algolia.com/policies/terms/).
**Requires Admin API key**
## OpenAPI
````yaml specs/agent-studio.yml patch /1/secret-keys/{secretKeyId}
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/secret-keys/{secretKeyId}:
patch:
tags:
- Secret Keys
summary: Patch Secret Key
description: Patch Secret Key.
operationId: updateSecretKey
parameters:
- name: secretKeyId
in: path
required: true
schema:
type: string
title: secretKeyId
description: The secretKeyId.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SecretKeyPatch'
responses:
'200':
description: Successful Response.
content:
application/json:
schema:
$ref: '#/components/schemas/SecretKeyResponse'
'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.UpdateSecretKeyAsync(
"a1b2c3d4-5678-90ab-cdef-123456789abc",
new SecretKeyPatch
{
Name = "renamed-key",
AgentIds = new List { "76710f1b-8231-42e5-b0d1-f43aac618e15" },
}
);
// 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.updateSecretKey(
secretKeyId: "a1b2c3d4-5678-90ab-cdef-123456789abc",
secretKeyPatch: SecretKeyPatch(
name: "renamed-key",
agentIds: [
"76710f1b-8231-42e5-b0d1-f43aac618e15",
],
),
);
// 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.UpdateSecretKey(client.NewApiUpdateSecretKeyRequest(
"a1b2c3d4-5678-90ab-cdef-123456789abc",
agentStudio.NewEmptySecretKeyPatch().SetName("renamed-key").SetAgentIds(
[]string{"76710f1b-8231-42e5-b0d1-f43aac618e15"})))
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
SecretKeyResponse response = client.updateSecretKey(
"a1b2c3d4-5678-90ab-cdef-123456789abc",
new SecretKeyPatch().setName("renamed-key").setAgentIds(Arrays.asList("76710f1b-8231-42e5-b0d1-f43aac618e15"))
);
// 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.updateSecretKey({
secretKeyId: 'a1b2c3d4-5678-90ab-cdef-123456789abc',
secretKeyPatch: { name: 'renamed-key', agentIds: ['76710f1b-8231-42e5-b0d1-f43aac618e15'] },
});
// 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.updateSecretKey(
secretKeyId = "a1b2c3d4-5678-90ab-cdef-123456789abc",
secretKeyPatch =
SecretKeyPatch(
name = "renamed-key",
agentIds = listOf("76710f1b-8231-42e5-b0d1-f43aac618e15"),
),
)
// 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->updateSecretKey(
'a1b2c3d4-5678-90ab-cdef-123456789abc',
['name' => 'renamed-key',
'agentIds' => [
'76710f1b-8231-42e5-b0d1-f43aac618e15',
],
],
);
// 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.update_secret_key(
secret_key_id="a1b2c3d4-5678-90ab-cdef-123456789abc",
secret_key_patch={
"name": "renamed-key",
"agentIds": [
"76710f1b-8231-42e5-b0d1-f43aac618e15",
],
},
)
# 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.update_secret_key(
"a1b2c3d4-5678-90ab-cdef-123456789abc",
Algolia::AgentStudio::SecretKeyPatch.new(name: "renamed-key", agent_ids: ["76710f1b-8231-42e5-b0d1-f43aac618e15"])
)
# 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.updateSecretKey(
secretKeyId = "a1b2c3d4-5678-90ab-cdef-123456789abc",
secretKeyPatch = SecretKeyPatch(
name = Some("renamed-key"),
agentIds = Some(Seq("76710f1b-8231-42e5-b0d1-f43aac618e15"))
)
),
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.updateSecretKey(
secretKeyId: "a1b2c3d4-5678-90ab-cdef-123456789abc",
secretKeyPatch: SecretKeyPatch(name: "renamed-key", agentIds: ["76710f1b-8231-42e5-b0d1-f43aac618e15"])
)
// print the response
print(response)
- lang: cURL
label: curl
source: |-
curl --request PATCH \
--url https://example.algolia.net/agent-studio/1/secret-keys/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",
"agentIds": [
"lorem"
]
}
'
components:
schemas:
SecretKeyPatch:
properties:
agentIds:
oneOf:
- items:
type: string
type: array
- type: 'null'
title: agentids
description: Updated list of agent IDs this secret key is associated with.
name:
oneOf:
- type: string
maxLength: 128
minLength: 1
- type: 'null'
title: name
description: The new name of the secret key.
type: object
title: secretKeyPatch
description: Secret key patch payload.
SecretKeyResponse:
properties:
agentIds:
items:
type: string
type: array
title: agentids
createdAt:
type: string
title: createdat
id:
type: string
title: id
lastUsedAt:
oneOf:
- type: string
- type: 'null'
title: lastusedat
name:
type: string
title: name
updatedAt:
type: string
title: updatedat
value:
type: string
title: value
isDefault:
type: boolean
title: isdefault
default: false
type: object
required:
- id
- name
- value
- createdAt
- updatedAt
- lastUsedAt
- agentIds
title: secretKeyResponse
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: detail
type: object
title: hTTPValidationError
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
LocationItemUnion:
oneOf:
- type: string
- type: integer
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.
````