Replace an AI agent

curl --request PUT \
  --url https://app.hookie.ai/admin/api/projects/{project_id}/ai-agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --cookie hookie_session= \
  --data '
{
  "name": "<string>",
  "active": true,
  "model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
  "system_prompt": "<string>",
  "prompt": "<string>",
  "tools": [
    "<unknown>"
  ],
  "memory_dataset": "<string>",
  "max_tokens": 1024
}
'

const options = {
  method: 'PUT',
  headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    active: true,
    model: '@cf/meta/llama-3.3-70b-instruct-fp8-fast',
    system_prompt: '<string>',
    prompt: '<string>',
    tools: ['<unknown>'],
    memory_dataset: '<string>',
    max_tokens: 1024
  })
};

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}"

payload = {
    "name": "<string>",
    "active": True,
    "model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "system_prompt": "<string>",
    "prompt": "<string>",
    "tools": ["<unknown>"],
    "memory_dataset": "<string>",
    "max_tokens": 1024
}
headers = {
    "cookie": "hookie_session=",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, 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>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": 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>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": 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>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": 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>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": 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>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": 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>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

PUT

admin

api

projects

{project_id}

ai-agents

{agent_id}

Replace an AI agent

curl --request PUT \
  --url https://app.hookie.ai/admin/api/projects/{project_id}/ai-agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --cookie hookie_session= \
  --data '
{
  "name": "<string>",
  "active": true,
  "model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
  "system_prompt": "<string>",
  "prompt": "<string>",
  "tools": [
    "<unknown>"
  ],
  "memory_dataset": "<string>",
  "max_tokens": 1024
}
'

const options = {
  method: 'PUT',
  headers: {cookie: 'hookie_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    active: true,
    model: '@cf/meta/llama-3.3-70b-instruct-fp8-fast',
    system_prompt: '<string>',
    prompt: '<string>',
    tools: ['<unknown>'],
    memory_dataset: '<string>',
    max_tokens: 1024
  })
};

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}"

payload = {
    "name": "<string>",
    "active": True,
    "model": "@cf/meta/llama-3.3-70b-instruct-fp8-fast",
    "system_prompt": "<string>",
    "prompt": "<string>",
    "tools": ["<unknown>"],
    "memory_dataset": "<string>",
    "max_tokens": 1024
}
headers = {
    "cookie": "hookie_session=",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, 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>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": 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>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": 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>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": 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>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": 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>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": 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>",
  "max_members": 123,
  "members": 123,
  "customer_id": "<string>",
  "customer_name": "<string>",
  "account_id": "<string>",
  "terms_version": "<string>",
  "claim_required": true
}

Authorizations

hookie_session

string

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

Body

application/json

Identical to the create body and validated by the same validateAgentSpec — FULL REPLACE, not a merge: an omitted field reverts to its default (omitting system_prompt blanks it, omitting tools empties it, omitting max_tokens resets it to 1024, omitting active re-activates). PATCH is accepted on this path and behaves identically.

name

string

required

Required string length: 1 - 120

active

boolean

default:true

model

enum<string>

default:@cf/meta/llama-3.3-70b-instruct-fp8-fast

As for create: a model off the list is refused.

Available options:

@cf/meta/llama-3.3-70b-instruct-fp8-fast,

@cf/meta/llama-3.1-8b-instruct,

@cf/meta/llama-3.1-8b-instruct-fast,

@cf/meta/llama-3.2-3b-instruct,

@cf/meta/llama-4-scout-17b-16e-instruct,

@cf/mistralai/mistral-small-3.1-24b-instruct,

@cf/google/gemma-3-12b-it

system_prompt

string

Maximum string length: 8000

prompt

string

tools

any[]

As for create: not supported; only an empty list is accepted.

memory_dataset

string | null

max_tokens

integer

default:1024

Response

Replaced.

enum<boolean>

required

Available options:

true

Get started

Concepts

CLI

Guides

API reference

Replace an AI agent

Authorizations

Path Parameters

Body

Response