Skip to main content
PATCH
/
api
/
v1
/
agents
/
{id}
/
status
/
Update Agent Status
curl --request PATCH \
  --url https://api.ravan.ai/api/v1/agents/{id}/status/ \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{}'
{
  "success": true,
  "message": "Agent status updated successfully",
  "data": { "id": "...", "status": "inactive" }
}

​
Authorizations

​
X-Api-Key
string
required
Your Agni API key used to authenticate the request. Pass it in the X-Api-Key header. Find or rotate it from your Ravan AI account settings.

​
Request

Example curl: 
curl -X PATCH "https://api.ravan.ai/api/v1/agents/{id}/status" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "inactive" }'

​
Path Parameters

​
id
string
required
The unique ID of the resource in the path. Use the ID returned by the related create or list endpoint.

​
Body

​
status
string
Filters or sets the current status of the resource. Use one of the status values supported by the endpoint.

​
Response

​
success
boolean
Whether the request succeeded.
​
message
string
Human-readable status message.
​
data
object
Returned data.
{
  "success": true,
  "message": "Agent status updated successfully",
  "data": { "id": "...", "status": "inactive" }
}

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

200 - application/json

Successful response

​
success
boolean
​
message
string
​
data
object