Skip to main content
POST
Read async job result

Authorizations

Authorization
string
header
required

Tenant secret key (lcr_…). Server-side only.

Headers

X-Locus-Session-Id
string

Required only when the end-user JWT carries sid. Send the original high-entropy session value; sid is its SHA-256 fingerprint. Ignored for secret-key authentication.

Required string length: 16 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{15,127}$
X-Locus-End-User
string

Secret-key callers must repeat the original end user. Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$

Path Parameters

callId
string<uuid>
required

The apiCallId of the submit call.

Body

application/json
waitSeconds
integer
default:0

Seconds to wait on the server for the job to finish. 0 reads the current state once.

Required range: 0 <= x <= 45
skip
integer

Result offset for paged results. Copy it from nextPage.

Required range: x >= 0
limit
integer

Results per page for paged results. Copy it from nextPage.

Required range: x >= 1

Response

Job state and provider result. No credits charged.

apiCallId
string<uuid>
required
provider
string
required
endpoint
string
required

The submit endpoint.

statusEndpoint
string
required

The provider status endpoint Locus read.

jobId
string
required
state
enum<string>
required
Available options:
pending,
completed,
failed
result
any
required

The provider status body. When state is completed it holds the final result.

billing
object
required
pollAfterMs
integer

Present when state is pending.

nextPage
object

Present when more result pages remain. Pass these values as skip and limit.