API ReferenceAgents

Delete agent

Delete an agent.

DELETE
/api/v1/console/agents/{agentId}

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Team API key (prefix sk_). You may also send the key via X-Api-Key header.

In: header

Path Parameters

agentId*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/console/agents/string"
{  "message": "Success",  "data": null}
{  "message": "Invalid API key.",  "error": "Unauthorized",  "code": "api_key_invalid",  "statusCode": 401,  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}
{  "message": "This API key is missing the required scope: conversations:read.",  "error": "Forbidden",  "code": "insufficient_scope",  "statusCode": 403,  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}
{  "message": "Agent not found",  "error": "Not Found",  "code": "not_found",  "statusCode": 404,  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}