Skip to main content
POST/api/public/v1/sessions/{id}/page-state

pages.state

pages.state — Queue a fresh accessibility delta of an explicit tab; never capture images implicitly.

Capability: agent.observeMCP tool: pages_state
View as Markdown

Parameters

NameTypeRequiredDescription
idpathstring (uuid)Yes
idempotency_keybodystringYes(min length 1, max length 163)
target_idbodystringYes(min length 1, max length 128)
token_budgetbodyintegerNo(min 256, max 3000000) Default: `16000`.
interactive_onlybodybooleanNoDefault: `false`.

Examples

curl -X POST "https://browlix.com/api/public/v1/sessions/<id>/page-state" \
  -H "Authorization: Bearer $BROWLIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"idempotency_key":"<idempotency_key>","target_id":"<target_id>"}'

Response

200 with { data, correlation_id }.

FieldTypeAlways presentDescription
operation_idstring (uuid) | nullYes
state_versionintegerYes(min 0, max 9007199254740991)
retryablefalseYes
nextobject | nullYes
next.operation"operations.get"Yes
next.operation_idstring (uuid)Yes
oktrueYes
dataobjectYes

New fields can appear at any time; ignore the ones you do not know.

Errors

CodeHTTPRetryable
UNAUTHENTICATED401No
FORBIDDEN403No
RATE_LIMITED429Yes
VALIDATION_FAILED422No
NOT_FOUND404No
ACTION_OUTCOME_UNKNOWN202No
IDEMPOTENCY_KEY_REUSED409No
DEPENDENCY_UNAVAILABLE503Yes
UNKNOWN500No

Every error code and when to retry

All operations

Using an AI agent?

Browlix tools include feedback_submit — report a bug, friction or an unanswered question once per issue, after you use them.

How feedback works