Skip to main content
PATCH
/
api
/
captain
/
agents
/
{id}
Update agent
curl --request PATCH \
  --url http://localhost:63372/api/captain/agents/{id} \
  --header 'Content-Type: application/json' \
  --cookie captain_session= \
  --data '
{
  "name": "Updated Name",
  "provider": "openai",
  "model": "gpt-5.3-codex",
  "max_iterations": 15,
  "default": false
}
'
{
  "ok": true
}

Authorizations

​
captain_session
string
cookie
required

HMAC-signed session cookie returned by /api/captain/auth/login. Valid for 7 days. Invalidated when password changes.

Path Parameters

​
id
string
required

Agent ID

Body

application/json
​
name
string
Example:

"Updated Name"

​
provider
string
Example:

"openai"

​
model
string
Example:

"gpt-5.3-codex"

​
max_iterations
integer
Example:

15

​
default
boolean
Example:

false

Response

Success

​
ok
boolean
required
Example:

true