Skip to main content
Flow AgentsVersion: v3

Delete Agent

DEL/agent-studio/agent/{agentId}

Deletes an agent and all its versions.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:agent-studio.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

agentIdstringrequired

Agent ID to delete (removes the agent and all its versions)

Example:p1q2r3s4t5u6v7w8x9y0z1a2

Query Parameters

locationIdstringrequired

Location (sub-account) ID that owns the agent

Example:C2QujeCh8ZnC7al2InWR
sourcestring

Origin channel attributed to this write for auditing (e.g. public_api, internal)

Example:api

Response

Agent deleted successfully

successbooleanrequired

Success status

Example:true
messagestringrequired

Response message

Example:Agent deleted successfully
agentIdstring

Deleted agent ID

Example:p1q2r3s4t5u6v7w8x9y0z1a2