Design Pipeline

Poll an async job

Status and result of a job returned as 202 + job_id (for example by POST /api/design/custom). Poll every few seconds until status is completed, failed or cancelled; the poll_url in the 202 response is this path. Free.

get/api/jobs/{job_id}

Request

  • Base URL: https://api.crayonz.ai
  • URL: https://api.crayonz.ai/api/jobs/{job_id}
  • Auth: API key in header X-API-Key

Path parameters

job_idstring required

The job_id from the 202 response

Response

Success

statusstring

"ok" when the job was found

jobobject

id, job_type, status (queued | running | completed | failed | cancelled), progress_pct, credits_charged, result (when completed), error_code and last_error (when failed), completed_at

Changes

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