Unpublish Agent

Unpublish the specified agent.

POST /1/agents/{agentId}/unpublish

curl

cURL

curl --request POST \
  --url https://example.algolia.net/agent-studio/1/agents/lorem/unpublish \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

// Initialize the client
var client = new AgentStudioClient(
  new AgentStudioConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
);

// Call the API
var response = await client.UnpublishAgentAsync("76710f1b-8231-42e5-b0d1-f43aac618e15");

// print the response
Console.WriteLine(response);

// Initialize the client
final client = AgentStudioClient(
    appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');

// Call the API
final response = await client.unpublishAgent(
  agentId: "76710f1b-8231-42e5-b0d1-f43aac618e15",
);

// print the response
print(response);

// 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.UnpublishAgent(client.NewApiUnpublishAgentRequest(
  "76710f1b-8231-42e5-b0d1-f43aac618e15"))
if err != nil {
  // handle the eventual error
  panic(err)
}


// print the response
print(response)

// Initialize the client
AgentStudioClient client = new AgentStudioClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");

// Call the API
AgentWithVersionResponse response = client.unpublishAgent("76710f1b-8231-42e5-b0d1-f43aac618e15");

// print the response
System.out.println(response);

// Initialize the client
const client = agentStudioClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

// Call the API
const response = await client.unpublishAgent({ agentId: '76710f1b-8231-42e5-b0d1-f43aac618e15' });


// print the response
console.log(response);

// Initialize the client
val client = AgentStudioClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

// Call the API
var response = client.unpublishAgent(agentId = "76710f1b-8231-42e5-b0d1-f43aac618e15")


// print the response
println(response)

// Initialize the client
$client = AgentStudioClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

// Call the API
$response = $client->unpublishAgent(
    '76710f1b-8231-42e5-b0d1-f43aac618e15',
);


// print the response
var_dump($response);

# 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.unpublish_agent(
    agent_id="76710f1b-8231-42e5-b0d1-f43aac618e15",
)


# print the response
print(response)

# Initialize the client
client = Algolia::AgentStudioClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

# Call the API
response = client.unpublish_agent("76710f1b-8231-42e5-b0d1-f43aac618e15")


# print the response
puts(response)

// Initialize the client
val client = AgentStudioClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

// Call the API
val response = Await.result(
  client.unpublishAgent(
    agentId = "76710f1b-8231-42e5-b0d1-f43aac618e15"
  ),
  Duration(100, "sec")
)

// print the response
println(response)

// Initialize the client
let client = try AgentStudioClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

// Call the API
let response = try await client.unpublishAgent(agentId: "76710f1b-8231-42e5-b0d1-f43aac618e15")

// print the response
print(response)

200

{
  "config": {},
  "createdAt": "<string>",
  "description": "<string>",
  "id": "<string>",
  "instructions": "<string>",
  "lastUsedAt": "<string>",
  "name": "<string>",
  "providerId": "<string>",
  "updatedAt": "<string>",
  "model": "<string>",
  "systemPrompt": "<string>",
  "templateType": "<string>",
  "tools": [
    {
      "description": "<string>",
      "inputSchema": {
        "properties": {},
        "required": [
          "<string>"
        ],
        "type": "object"
      },
      "name": "<string>",
      "type": "client_side"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

This is a beta feature according to Algolia’s Terms of Service (“Beta Services”).

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

agentId · string · required

The agentId.

Response

200

application/json

Successful Response.

config · config · object · required

createdAt · string · required

description · string | null · required

id · string · required

instructions · string · required

lastUsedAt · string | null · required

name · string · required

providerId · string | null · required

status · enum<string> · required

Available options: draft, published

updatedAt · string | null · required

model · string | null

systemPrompt · string | null

templateType · string | null

tools · (clientSideToolConfig · object | algoliaSearchToolConfig · object | algoliaRecommendToolConfig · object | algoliaDisplayResultsToolConfig · object | mcpServerToolConfig · object | unknownToolConfig · object)[]

clientSideToolConfig

algoliaSearchToolConfig

algoliaRecommendToolConfig

algoliaDisplayResultsToolConfig

mcpServerToolConfig

unknownToolConfig

Show child attributes