Skip to main content
POST
/
1
/
agents
/
{agent_id}
/
unpublish
Unpublish Agent
curl --request POST \
  --url https://{APPLICATION_ID}.algolia.net/agent-studio/1/agents/{agent_id}/unpublish \
  --header 'X-Algolia-API-Key: <x-algolia-api-key>' \
  --header 'X-Algolia-Application-Id: <x-algolia-application-id>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "status": "draft",
  "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "instructions": "<string>",
  "config": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "model": "<string>",
  "systemPrompt": "<string>",
  "tools": [
    {
      "name": "<string>",
      "description": "<string>",
      "inputSchema": {
        "type": "object",
        "properties": {},
        "required": [
          "<string>"
        ]
      },
      "type": "client_side"
    }
  ],
  "templateType": "<string>"
}
Required ACL: editSettings

Headers

​
X-Algolia-API-Key
string
required
​
X-Algolia-Application-Id
string
required

Path Parameters

​
agent_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
name
string
required
​
description
string | null
required
​
status
enum<string>
required
Available options:
draft,
published
​
providerId
string<uuid> | null
required
​
instructions
string
required
​
config
Config · object
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time> | null
required
​
lastUsedAt
string<date-time> | null
required
​
model
string | null
​
systemPrompt
string | null
​
tools
(ClientSideToolConfig · object | AlgoliaSearchToolConfig · object | AlgoliaRecommendToolConfig · object | McpServerToolConfig · object | UnknownToolConfig · object)[]
​
templateType
string | null
Last modified on March 5, 2026