self-serve

Read one job (quota-free).

get/v1/jobs/{id}

Request

  • Base URL: https://api.mapmap.ai
  • URL: https://api.mapmap.ai/v1/jobs/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_key

Path parameters

idstring required

Job id from the submission's 202

Response

The job: status, and result inline once it is succeeded

created_atstring required

RFC 3339 UTC submission time.

errorstring nullable

Why the job failed, once status is failed.

finished_atstring nullable

RFC 3339 UTC time the job finished, either way.

idstring required

Opaque job id (UUID v4), as returned by the submission.

kindstring required

optimise or matrix.

refundedboolean required

Whether a failure refunded the submission's units and pence.

resultunknown
result_urlstring required

Where to fetch this job (and its result), the same URL the webhook carries.

started_atstring nullable

RFC 3339 UTC time a worker picked the job up.

statusstring required

queued, running, succeeded or failed.

units_chargedinteger required

Metered units the submission drew. Zero after a failure refund would be a lie, this is what was CHARGED, and refunded says whether it came back.

webhook_statusstring nullable

delivered or delivery_failed once a webhook was attempted.

Changes

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