Skip to main content
PUT
/
agents
/
{id}
/
enable
Enable/Disable Agent
curl --request PUT \
  --url https://api.example.com/agents/{id}/enable

Documentation Index

Fetch the complete documentation index at: https://docs.orkeia.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

PUT https://gateway.orkeia.ai/agents/{id}/enable

​
Headers

authorization:  <your_token>
Content-Type: application/json

​
Path Parameters

You must pass the agent’s id via query params 
{
  "id": "Agent ID (required)"
}

​
Request body

{
  "enabled": true/false
}
NameTypeRequiredDescription
enabledbooleanYesWhether the agent is enabled or not

​
Example (cURL)

curl -X PUT "https://gateway.orkeia.ai/agents/agent123/enable" \
  -H "authorization:  <your_token>" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": true}'

​
Responses

​
Response - Success

response
{
  "status": "OK",
  "data": { "true"}
}

​
500 — Bad Request

{
  "status": "ERROR",
  "code": "server/error",
  "data": null
}

​
400 — Client Error

{
  "status": "ERROR",
  "code": "client/error",
  "data": null
}