Skip to main content
POST/api/public/v1/workers/{id}/provision/preview

workers.provision_preview_request

workers.provision_preview_request — Request the same exact host snapshot as the UI; UNSUPPORTED when worker cannot preview, BUSY while sessions run.

Capability: device.manageCommand (idempotent)MCP tool: workers_provision_preview_request
View as Markdown

Parameters

NameTypeRequiredDescription
idpathstring (uuid)YesDevice id
command_idbodystring (uuid)YesClient-generated UUID for this command. Send the same id (and body) again to get the stored receipt instead of a second change; a different body under the same id is CONFLICT.
idempotency_keybodystringNo(min length 1, max length 163)
actionbody"apply" | "undo"Yes

Examples

curl -X POST "https://browlix.com/api/public/v1/workers/<id>/provision/preview" \
  -H "Authorization: Bearer $BROWLIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command_id":"<uuid>","action":"apply"}'

Response

201 with { data, replayed: false, correlation_id } the first time; 200 with replayed: true when the same command_id and body come again.

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
CONFLICT409No
OUTCOME_UNKNOWN202Yes
ACTION_OUTCOME_UNKNOWN202No
IDEMPOTENCY_KEY_REUSED409No
BUSY409Yes
UNSUPPORTED501No
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