Skip to main content
POST
Request a change to a tool

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Repeat a request safely: the same key and body answer the first request's job again with Idempotent-Replayed: true; the same key with a different body answers idempotency_conflict. 1 to 200 letters, digits, _ or -, such as a UUID

Pattern: ^[A-Za-z0-9_-]{1,200}$

Path Parameters

id
string
required

a tool ID: tool_ and 32 lowercase hex digits

Example:

"tool_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"

Body

application/json
change
string
required

What the tool should do differently, in plain words

Required string length: 1 - 2000
example_input

The input of the one example the change runs, using any input the change adds. A write tool's change needs it and runs that example once for real

login_id
string

The saved login to sign in with, when the site has several

Example:

"login_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"

login
object

A login for this call, used only when the site has no saved login: a username (or email, phone or account number) and password, or mode "code" without a password when the site sends a code. It passes through your client and model provider; without it, the run asks the person on its answer page.

save_login
boolean

Save login for later runs (requires login)

redact_at_rest
boolean

Staging and preview only: true seals what this job stores and redacts it once it settles, false keeps it readable, overriding the environment's setting. Production refuses a request that names it with invalid_request.

Response

The job this Idempotency-Key already started, with Idempotent-Replayed: true

id
string
required

a job ID: job_ and 32 lowercase hex digits

Example:

"job_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"

type
enum<string>
required
Available options:
run,
build
status
enum<string>
required
Available options:
queued,
running,
needs_input,
succeeded,
failed,
cancelled
tool_id
string | null
required
input_request
object | null
required
result
any
required
result_status
enum<string> | null
required
Available options:
available,
delivered,
expired
result_expires_at
string | null
required

a string to be decoded into a Date

write_status
enum<string> | null
required
Available options:
not_attempted,
may_have_applied,
applied,
not_applied
login_save
object | null
required
error
object | null
required
message
string | null
required
maintenance
object | null
required
build
object | null
required
watch_url
string
required
created_at
string
required

a string to be decoded into a Date

updated_at
string
required

a string to be decoded into a Date

completed_at
string | null
required

a string to be decoded into a Date

tip
string