Skip to main content
POST
browser.task.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by browser.task.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

status
enum<string>
required

Current task state.

Available options:
pending,
running,
completed,
failed,
cancelled
goal
string
required

Task goal; may contain personal data.

createdAt
string

Time in ISO 8601 UTC.

startedAt
string

Time in ISO 8601 UTC.

finishedAt
string

Time in ISO 8601 UTC.

stepCount
integer

Steps taken, when known.

Required range: 0 <= x <= 9007199254740991
output
any

Requested task output, sanitized and bounded.

outputSchema
any

Requested output structure, when recorded.

errorCategory
enum<string>

Neutral category for a terminal error.

Available options:
system,
task,
billing,
unknown