Skip to main content
PATCH
Authenticate with Authorization: Bearer sk_live_... on https://api.agent37.com.

Path parameters

string
required
The instance id, returned when you create an instance.

Request body

The examples include every editable field. Send only the fields you want to change.
string | null
optional
A label for the instance, up to 60 characters. null or "" clears it.
string | null
optional
Your attribution tag, up to 200 characters. null or "" clears it.
object | null
optional
Your key/value pairs, up to 4 KB serialized. The object replaces the stored one, it is not merged. null or {} clears it.
boolean
optional
Turn auto-sleep on or off. Takes effect within about half a minute, with no restart and no recreate.
integer
optional
The new idle timeout: an integer from 300 to 86400 seconds.

Response

The response contains the full instance object, including its resources, URLs, and timestamps. The example shows only the id and edited fields.

Update behavior

PATCH /v1/instances/{id} edits the instance’s name, user tag, and metadata after creation, plus its auto-sleep settings. These are the same fields you can set at create, and they are the only things this call changes: it never touches the running container. It returns 200 with the full instance object, the same shape as GET. The patch is partial: only the keys you send change, the rest are left alone. Send a string to set a label field, or null (or "") to clear it. You must send at least one of name, user, metadata, auto_sleep, or idle_timeout_seconds; an empty body returns 400 invalid_request. Edits never bill and never recreate the container, and they work in any state except deleted. Unknown, deleted, or other-workspace ids return 404 not_found.