Skip to main content
PATCH
Update an intern

Authorizations

Authorization
string
header
required

API key as bearer token in Authorization header

Path Parameters

internId
string
required

ID of an intern visible to the authenticated API key.

Minimum string length: 1
Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

Body

application/json

Lifecycle settings to change. Omitted fields stay unchanged and null clears a field.

description
string | null

New free-form description. Null clears it.

Maximum string length: 2000
instructions
string | null

New standing instructions. Null clears them.

Maximum string length: 100000
model
string | null

New OpenRouter model slug. Null restores the workspace default.

Maximum string length: 200
name
string

New intern name, unique per creator within the workspace.

Required string length: 2 - 17
Pattern: ^[a-z][a-z0-9]*(-[a-z0-9]+)*$

Response

Updated intern.

Public lifecycle state and settings for one intern.

attached_vault_id
string | null
required

Vault the intern borrows from another intern, or null when it borrows none.

createdAt
string
required

ISO 8601 creation time.

description
string | null
required

Free-form description.

hostname
string | null
required

Public hostname the intern is reachable at, or null until provisioning has assigned one.

id
string
required

Intern id.

instructions
string | null
required

Standing instructions the intern boots with.

lastFailureMessage
string | null
required

Why the last provisioning attempt failed, when status is failed.

model
string | null
required

OpenRouter model slug the intern runs, or null for the workspace default.

name
string
required

Intern name, unique per creator within a workspace.

progress
object | null
required

Active provisioning step, or null once provisioning has settled.

status
enum<string>
required

Lifecycle status.

Available options:
awaiting_slack_install,
queued,
provisioning,
running,
failed,
stopped,
destroying,
destroy_failed
updatedAt
string
required

ISO 8601 last update time.

vault_id
string | null
required

Vault the intern owns, or null before it has been created.

workspaceId
string
required

Workspace that owns the intern and scopes its secrets.