Delete an agent
Soft-deletes the agent: it disappears from every read, but its versions and conversations are preserved. Returns the id and a deleted flag.
Authorization
ApiKeyAuth AuthorizationBearer <token>
A WorkOS org-scoped API key, created from the dashboard's organization settings page. Identifies the tenant every read and write is scoped to. Missing, malformed, unknown, revoked, expired, or non-organization-owned keys all return 401 (no distinction, so the response can't be used to probe which keys or org ids exist).
In: header
Path Parameters
siteId*string
The site id (prefixed site_). A site id that isn't yours is a 404, same as any other cross-tenant id.
id*string
The agent id (prefixed agt_).
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X DELETE "https://example.com/api/v1/sites/string/agents/string"{ "data": { "id": "agt_01kvnwmagvf27rc9cze5rm9e1r", "deleted": true }}