Agent Disable API

Enable or disable an agent programmatically

Enables or disables an agent in your workspace. Disabled agents cannot be used by workspace members until re-enabled.

Before You Start

• Legacy Assistants API: This is the new Agents API with native Vercel AI SDK compatibility. If you're using the legacy Assistants API, see the migration guide.
• Admin action: This is an administrative action. Only workspace admins or users with appropriate permissions can disable/enable agents.

Base URL

https://api.ajan.io/agent/v1/disable

Use Cases

• Temporarily disable an agent that needs maintenance or updates
• Re-enable a previously disabled agent
• Control agent availability during rollouts or testing

Parameters

Example

const axios = require("axios");

async function toggleAgentStatus(agentId, disabled) {
  const response = await axios.patch(
    "https://api.ajan.io/agent/v1/disable",
    {
      agentId: agentId,
      disabled: disabled
    },
    {
      headers: {
        Authorization: "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
      }
    }
  );

  console.log(`Agent ${disabled ? 'disabled' : 'enabled'}:`, response.data);
}

// Disable an agent
toggleAgentStatus("550e8400-e29b-41d4-a716-446655440000", true);

// Re-enable an agent
toggleAgentStatus("550e8400-e29b-41d4-a716-446655440000", false);

Response Format

Success Response (200 OK)

{
  status: "success";
  message: "Agent disabled successfully" | "Agent enabled successfully";
}

Error Handling

Behavior

When an agent is disabled:

• Users cannot start new conversations with the agent
• The agent does not appear in the agent library for regular users
• Existing conversations may still be viewable but the agent cannot respond
• Admins can still view and manage the agent
• The agent can be re-enabled at any time