PATCH
/
api
/
v1
/
agents
/
{id}
/
status
curl -X PATCH https://api.ravan.ai/api/v1/agents/019d1fdb-98e9-7c87-86c7-321e2fa98733/status/ \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "AGENT_STATUS_INACTIVE"}'

{
  "success": true,
  "message": "Agent status updated successfully",
  "data": null
}

​
Authorizations

​
X-Api-Key
string
required
Your Agni API key. Find it in your support@ravan.ai under Settings → API Keys.

​
Path Parameters

​
id
string
required
The unique UUID of the agent whose status you want to change.

​
Body

​
status
string
required
New status for the agent. Allowed values:
  • AGENT_STATUS_ACTIVE — agent can receive and make calls.
  • AGENT_STATUS_INACTIVE — agent is paused and will not handle calls.
  • AGENT_STATUS_UNSPECIFIED — reset to default state.

​
Response

​
success
boolean
Whether the request succeeded.
​
message
string
Human-readable status message.
​
data
object
null on success. The status change is confirmed by the success field.
curl -X PATCH https://api.ravan.ai/api/v1/agents/019d1fdb-98e9-7c87-86c7-321e2fa98733/status/ \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "AGENT_STATUS_INACTIVE"}'

{
  "success": true,
  "message": "Agent status updated successfully",
  "data": null
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
id
string
required

Agent ID

Body

application/json
​
status
enum<string>

Status of the agent

Available options:
AGENT_STATUS_UNSPECIFIED,
AGENT_STATUS_ACTIVE,
AGENT_STATUS_INACTIVE

Response

Successful response

​
success
boolean
​
message
string
​
data
object