latestOpenAPI 3.0.32026-08-2142130334.7 KB
0a94056fba48
Agents
Retire an agent
Retires (archives) an agent: revokes its credential, deletes its bound API keys, releases its display name, and archives its membership. Requires the agents:write scope. A personal-scope agent can only be retired by its creator.
post/agents/{agentId}/retire
Path parameters
agentIdstring required
Agent membership identifier.
Agent membership identifier.
Response
Retired agent.
Example response
{
"data": {
"id": "01jzn7e61x3a7v9h2r7t2m3q4p",
"created_by": {
"id": "01jzn7e61x3a7v9h2r7t2m3q4p"
},
"created_at": "2026-05-14T08:00:00.000Z",
"updated_at": "2026-05-14T08:00:00.000Z"
}
}