forms

Check on a paid job, free

Free. The 402 and the 202 both carry this link as status_url, token included. Check status_url every few seconds until status is ready or failed. One plain word: awaiting_payment (priced, not yet paid), working (still running; check again after poll_after_seconds), ready (finished: result carries the output and, for a job that produces a file, a download link that stays the same on every check), failed (error says why; retry, when present, says how to run it again at no charge), or expired (the result's files are deleted, about an hour after the job, or a price that was never paid has expired: send the request again for a new one). For a fax, ready means the carrier accepted it; keep checking until result.status is delivered, failed or expired. A failed or expired fax is refunded: by card automatically, up to three refunds a day, and by stablecoin through contact@getemboss.ai. A resend with the same MPP payment, a free retry included, works only while its payment challenge stays valid, 15 minutes from the 402; after that, check status_url from the 402, and for a failed job contact contact@getemboss.ai with your job id.

get/pay/jobs/{job_id}

Request

  • Base URL: https://api.getemboss.ai
  • URL: https://api.getemboss.ai/pay/jobs/{job_id}
  • Auth: none required

Path parameters

job_idstring required

The job_id from the 402 or the 202.

Query parameters

tokenstring required

The token in status_url.

Response

The job's status.

job_idstring required
quote_idstring required
status'awaiting_payment' | 'working' | 'ready' | 'failed' | 'expired' required

One plain word: awaiting_payment (priced, not yet paid), working (still running; check again after poll_after_seconds), ready (finished: result carries the output and, for a job that produces a file, a download link that stays the same on every check), failed (error says why; retry, when present, says how to run it again at no charge), or expired (the result's files are deleted, about an hour after the job, or a price that was never paid has expired: send the request again for a new one). For a fax, ready means the carrier accepted it; keep checking until result.status is delivered, failed or expired. A failed or expired fax is refunded: by card automatically, up to three refunds a day, and by stablecoin through contact@getemboss.ai.

quote_statusstring required

The quote's own older word: quoted, claimed, executed or expired.

runsinteger required

Runs used; one payment covers 3.

resultobject

On ready: the output, with download_url when the job produced a file (a read or a fax has none).

errorstring

On failed or expired: why, in plain words.

retrystring

On failed, when a free run is available: how to run it again at no charge.

poll_after_secondsinteger

On working and awaiting_payment only: how long to wait before checking again.

proposal_idstring

two_call only: the proposal to read and commit.

commit_tokenstring

two_call only: send as X-Proposal-Token on the proposal routes; lives 45 minutes.

proposal_urlstring uri

two_call only: GET the proposal, token included.

Changes

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