Delete Agent
DELETE/api/agents/delete
This endpoint deletes an existing agent by its ID. The request must include a valid API key and user ID.
Request
Header Parameters
API key to authorize the request.
ID of the user making the request.
- application/json
Body
required
The unique identifier of the agent to delete.
Responses
- 200
- 400
- 403
- 404
- 405
- 500
Successfully deleted the agent.
- application/json
- Schema
- Example (from schema)
Schema
Response message confirming the deletion.
{
"message": {}
}
Invalid request body or missing agent ID.
- application/json
- Schema
- Example (from schema)
Schema
Error message indicating the issue with the request.
{
"message": "string"
}
Invalid API key or authentication failed.
- application/json
- Schema
- Example (from schema)
Schema
Detailed error message indicating authentication failure.
{
"message": "string"
}
Agent not found.
- application/json
- Schema
- Example (from schema)
Schema
Error message indicating that the agent was not found.
{
"message": "string"
}
Method not allowed.
- application/json
- Schema
- Example (from schema)
Schema
Error message indicating that the method is not allowed.
{
"message": "string"
}
Internal server error.
- application/json
- Schema
- Example (from schema)
Schema
Error message indicating an internal server error.
{
"message": "string"
}