API
POST /api/agents/{slug}/retire
Retire Agent
POST /api/agents/{slug}/retire
Retire Agent
Authentication: Authorization: Bearer <key> or X-API-Key: <key>. Create keys at developers.cognitivx.io/keys.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
slug | path | string | Yes | - |
dry_run | query | boolean | No | Defaults to false. |
X-Org-ID | header | string | null | No | - |
Example request
curl -X POST https://api.cognitivx.io/api/agents/{slug}/retire \
-H "Authorization: Bearer icog_..."Example response
200 application/json
nullResponses
| Status | Description |
|---|---|
200 | Success. Returns the response body shown below. |
422 | Request validation failed. detail lists each offending field. |