Skip to main content
PATCH
Update Agent Status

Authorizations

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:

Path Parameters

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

Body

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

Response

boolean
Whether the request succeeded.
string
Human-readable status message.
object
Returned data.

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