Jobs

Get a job

Returns the current status, progress, and (when complete) the result for a single job. SDK consumers typically wrap this in a polling loop — see client.jobs.waitFor().

get/v2/jobs/{id}

Request

  • Base URL: https://api.apiframe.ai
  • URL: https://api.apiframe.ai/v2/jobs/{id}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

idstring uuid required

Response

Job state.

idstring uuid required
status'QUEUED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required
modelstring required
progressinteger nullable required
inputobject nullable
resultunknown
errorstring nullable required
creditCostinteger nullable required
webhookStatus'pending' | 'delivered' | 'failed' | 'null' nullable required
createdAtstring date-time required
completedAtstring date-time nullable required
expiredboolean

true once a COMPLETED job's CDN assets have been purged (default 24h retention). result URLs may 404.

Changes

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