Skip to navigation
API ReferenceAgents

Delete

Deletes an agent by name or ID.

Authentication

AuthorizationBearer

Bearer authentication header of the form Bearer <PHONIC_API_KEY>. Manage your API keys here.

Path parameters

nameOrIdstringRequired
The name or the ID of the agent to delete.

Query parameters

projectstringOptionalDefaults to main

The name of the project containing the agent. Only used when nameOrId is a name.

Response

Success response
successboolean
Whether the agent was deleted successfully.

Errors

403
Forbidden Error
404
Not Found Error