Skip to main content
POST
Page Act

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-notte-request-origin
string | null
x-notte-sdk-version
string | null

Path Parameters

session_id
string
required

Query Parameters

update_metadata
boolean
default:true

Body

application/json
instruction
string
required

What to do, e.g. "accept the cookies".

Minimum string length: 1
variables
Variables · object | null

Values for {{name}} placeholders in typed text, substituted after the model call: they never reach a model.

dry_run
boolean
default:false

Choose the action without running it (status="proposed").

min_confidence
number
default:0

Below this decider confidence nothing runs (status="blocked").

Required range: 0 <= x <= 1

Response

Successful Response

instruction
string
required
status
enum<string>
required
Available options:
executed,
proposed,
done,
blocked,
stale
action
FormFillAction · object
execution
ExecutionResult · object | null
operation
string | null
target
string | null
value
string | null
confidence
number | null
probabilities
Probabilities · object
operation_probabilities
Operation Probabilities · object
model
string | null
message
string | null
fingerprint
string | null
timings
ActTimings · object