Delete an agent

DELETE /v1/agents/{agent_id}

Take the agent off the air and put it in the trash. Its conversations, recordings and numbers stay with it for 30 days, while the console can restore it; then it is gone for good. Needs agents:write and a live key.

Parameters

Name	In	Type	Required	Description
`agent_id`	path	string (uuid)	Yes

Answer

200 with AgentDeleted.

Errors

Every error is a problem document with a stable code.

Status	When
`401`	The key is missing, mistyped, unknown, revoked or expired.
`403`	The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something.
`404`	This key reaches no such agent.
`409`	The project is frozen.
`422`	Validation Error
`429`	Too many requests for this key or its organization; see `Retry-After`.
`500`	Something went wrong on our side. Quote the `request_id` to support.

Examples

Delete an agent

#!/bin/sh
# Delete an agent. The console can restore it for 30 days. With a live key.
curl -sS --fail-with-body -X DELETE "https://api.aigently.ai/v1/agents/9b1d3f5a-7c9e-4b1d-a3f5-7c9e1b3d5f7a" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.