Sign in
agents

Delete the agent: force stop it, shut down its devbox, and hide the run.

Changed on

Soft-deletes the run so normal reads no longer return it while retaining its durable history. Use POST /agents/:id/stop to force stop an agent while keeping it visible.

delete/agents/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/agents/{id}
  • Auth: none declared. Required headers: x-organization-id

Path parameters

idstring required

Headers

x-organization-idstring required

Active organization id (or slug). Required for org-scoped operations; the generated client enforces it at compile time.

Response

Response

idstring required
streamIdstring required
agentTypestring required
status'starting' | 'running' | 'needs_input' | 'completed' | 'interrupted' | 'stopping' | 'stopped' | 'error' | 'terminated' required
turnState'working' | 'idle' nullable required
turnStateVersioninteger required
devboxIdstring nullable required
tunnelKeystring nullable
namestring required
promptstring required
systemPromptstring nullable
personaIdstring nullable
modelstring nullable
blueprintIdstring nullable
blueprintNamestring nullable
promptMode'implement' | 'plan' | 'review' nullable
createdAtnumber required
lastActiveAtnumber nullable
archivedboolean required
ownerIdstring required
userIdstring nullable
prUrlstring nullable
hasBackgroundWorkboolean
listenersEnabledboolean
suspendAtTurnEndboolean
organizationIdstring required
modelProviderSecretIdstring nullable
credentialSyncPendingboolean nullable
originatorstring nullable
pinnedboolean required
mark'blocked' | 'in_review' | 'completed' nullable
viewerAccess'owner' | 'edit' | 'view'

Changes