Burn

Read async job result

Read the provider result of an async job, such as clado/bulk-contacts. Pass the apiCallId returned by the submit call. Locus reads the job id from that call's receipt. Reads are free and never create a new charge, so polling the same call again is safe. Access follows the submit endpoint's scope. Set waitSeconds to wait on the server for up to 45 seconds. When state is pending, call again after pollAfterMs. When nextPage is present, call again with its skip and limit to read the next page. A call that started no provider job, such as a call sent with Prefer: respond-async, returns its own stored outcome instead: state, the httpStatus and body the call would have returned, and billing for the read.

post/wrapped/credits/calls/{callId}/result

Request

  • Base URL
    https://api.paywithlocus.com/api
  • URL
    https://api.paywithlocus.com/api/wrapped/credits/calls/{callId}/result
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP bearer

Path parameters

callIdstring uuid required

The apiCallId of the submit call.

Headers

X-Locus-Session-Idstring

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.

X-Locus-End-Userstring

Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.

Secret-key callers must repeat the original end user.

Request body

waitSecondsinteger

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

skipinteger

Result offset for paged results. Copy it from nextPage.

limitinteger

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

Response

Job state and provider result. No credits charged.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.