Delete
/api/v1/ai-agents/{id}Permanently deletes an AI agent and cannot be undone.
Refused with 409 while a workflow rule still assigns conversations to the agent, or while it is still handling open conversations. Remove it from those workflows, or wait for the conversations to close, and try again.
Request
Authorization
Bearer Token
Provide your API token in the Authorization header. See Authentication to issue one.
Example:Authorization: Bearer ********************
idstringrequiredAI agent ID.
Example:6ad97ee52845b4f2c8daca55
Responses
200OK
OK
requestIdstringrequiredUnique ID for this request. Quote it when reporting a problem.
messagestringrequired
400Invalid body or parameters, e.g. an empty name, an unknown node type or a malformed ID.
Invalid body or parameters, e.g. an empty name, an unknown node type or a malformed ID.
messagestringrequired
401API key missing, invalid, revoked or expired.
API key missing, invalid, revoked or expired.
messagestringrequired
404No AI agent with this ID in your workspace.
No AI agent with this ID in your workspace.
messagestringrequired
409The agent is used by a workflow rule (the message names it) or still has open conversations.
The agent is used by a workflow rule (the message names it) or still has open conversations.
messagestringrequired
429Rate limit reached. Retry after a short pause.
Rate limit reached. Retry after a short pause.
messagestringrequired
502The AI agent service is temporarily unavailable. Retry shortly.
The AI agent service is temporarily unavailable. Retry shortly.
messagestringrequired