Retire, or permanently delete, an AI agent - Hookie

Retire, or permanently delete, an AI agent

curl --request DELETE \
  --url https://app.hookie.ai/admin/api/projects/{project_id}/ai-agents/{agent_id} \
  --cookie hookie_session=

const options = {method: 'DELETE', headers: {cookie: 'hookie_session='}};

fetch('https://app.hookie.ai/admin/api/projects/{project_id}/ai-agents/{agent_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.hookie.ai/admin/api/projects/{project_id}/ai-agents/{agent_id}"

headers = {"cookie": "hookie_session="}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "ok": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

DELETE

/

admin

/

api

/

projects

/

{project_id}

/

ai-agents

/

{agent_id}

Retire, or permanently delete, an AI agent

curl --request DELETE \
  --url https://app.hookie.ai/admin/api/projects/{project_id}/ai-agents/{agent_id} \
  --cookie hookie_session=

const options = {method: 'DELETE', headers: {cookie: 'hookie_session='}};

fetch('https://app.hookie.ai/admin/api/projects/{project_id}/ai-agents/{agent_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.hookie.ai/admin/api/projects/{project_id}/ai-agents/{agent_id}"

headers = {"cookie": "hookie_session="}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "ok": true
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

{
  "error": "<string>",
  "retry_after": 123,
  "upgrade_url": "<string>",
  "reason": "<string>",
  "code": "agent_scope_insufficient",
  "required_scope": "hookie:read",
  "granted_scopes": [
    "<string>"
  ],
  "manage_url": "<string>",
  "scheme": "<string>"
}

Authorizations

hookie_session

string

cookie

required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

project_id

string

required

agent_id

string

required

Query Parameters

permanent

boolean

default:false

true removes the agent for good. Omitted, the agent is retired: active is set to 0 and the definition kept, so PATCH active:true brings it back.

Response

By default the agent is retired - active set to 0, still listed, and an agent_call step naming it fails until it is reactivated. With ?permanent=true the row is removed and it leaves listAiAgents; a step naming it then fails with not found.

ok

enum<boolean>

required

Available options:

true