DELETE
/
agents
/
{agent_id}
curl --request DELETE \
  --url https://agent-prod.studio.lyzr.ai/v3/agents/{agent_id} \
  --header 'x-api-key: <api-key>'
{
  "message": "Agent deleted successfully."
}

Endpoint

DELETE /v3/agents/{agent_id}

Authentication

  • Requires an API key (x-api-key) in the request headers.

Path Parameters

ParameterTypeDescription
agent_idstringUnique identifier of the agent to delete.

Request Example (cURL)

curl -X DELETE "https://agent-prod.studio.lyzr.ai/v3/agents/{agent_id}" ^
-H "accept: application/json" ^
-H "x-api-key: sk-default-REPLACED-API-KEY"

Response Example

{
  "message": "Agent deleted successfully."
}

Authorizations

x-api-key
string
header
required

Path Parameters

agent_id
string
required

Unique identifier of the agent to delete.

Response

200
application/json

Agent deleted successfully

The response is of type object.