Delete an agent - Aster Agents

{ "id": 1, "name": "Customer Support Agent", "stage": "development", "showInChat": true, "createdAt": "2024-01-15T10:30:00.000Z", "updatedAt": "2024-01-20T14:00:00.000Z", "description": "Handles customer inquiries and support tickets", "logoUrl": "<string>", "conversationStarters": [ "How can I help you today?", "What issue are you experiencing?" ], "model": "openai:gpt-4o", "maxToolRoundtrips": 50, "systemPrompt": "<string>", "tools": {}, "mcpServers": [ 123 ], "emailSlug": "support-bot", "publishedVersionId": 42, "tags": [ { "id": 1, "name": "Production" } ] }

Authorizations

Authorization

string

header

required

JWT token from Clerk authentication.

Must be from a user with org:admin role.

Body

application/json

agentId

integer

required

The ID of the agent to delete

Example:

1

Response

Agent deleted successfully

integer

required

Unique agent identifier

Example:

1

name

string

required

Agent name

Example:

"Customer Support Agent"

stage

enum<string>

required

Agent lifecycle stage

Available options:

development,

released

Example:

"development"

showInChat

boolean

required

Whether the agent appears in the chat interface

Example:

true

createdAt

string<date-time>

required

When the agent was created

Example:

"2024-01-15T10:30:00.000Z"

updatedAt

string<date-time>

required

When the agent was last updated

Example:

"2024-01-20T14:00:00.000Z"

description

string | null

Short description of the agent's purpose

Example:

"Handles customer inquiries and support tickets"

logoUrl

string | null

URL to the agent's logo image

conversationStarters

string[] | null

Suggested conversation starters shown to users

Example:

[
  "How can I help you today?",
  "What issue are you experiencing?"
]

model

string | null

Model identifier (e.g., openai:gpt-4o)

Example:

"openai:gpt-4o"

maxToolRoundtrips

integer | null

Maximum number of tool call roundtrips per response

Example:

50

systemPrompt

string | null

System prompt / instructions for the agent

tools

object | null

Tool definitions keyed by tool name

mcpServers

integer[] | null

Connected MCP server IDs (integer mcp_server.id values)

emailSlug

string | null

Custom email slug for the agent's email address

Example:

"support-bot"

publishedVersionId

integer | null

ID of the agent_version snapshot this agent's config currently reflects. Every save appends a version and advances this pointer; see GET /agents/versions. The live agent fields above remain the source of truth — this is bookkeeping for history and rollback.

Example:

42