Skip to main content
POST
Delete Agent
Use this API to delete a custom agent configuration and all its versions. Group cleanup: Before the agent document and its versions subcollection are recursively deleted, the agentId is removed from the agentIds array of every agent group it belongs to. A cleanup failure aborts the delete and leaves the agent intact, so the call can safely be retried. Groups themselves are never deleted as part of agent deletion, even when they become empty.

Endpoint

POST https://api.velt.dev/v2/agents/delete

Headers

x-velt-api-key
string
required
Your API key.
x-velt-auth-token
string
required

Body

Params

data
object
required

Example Requests

Delete a custom agent

Response

Success Response

FieldTypeDescription
data.agentIdstringThe ID of the deleted agent

Failure Response

Errors: NOT_FOUND (agent does not exist).