Jobs

Status and result of a queued job

Poll this after a call made with sync: false. status moves queued → running → succeeded or failed; the result field appears only on success, and holds exactly what the synchronous call would have returned. A failure carries the same actionable error body a synchronous call would have thrown.

get/v1/jobs/{jobId}

Request

Base URL: https://api.tryplayhead.com
URL: https://api.tryplayhead.com/v1/jobs/{jobId}
Auth: HTTP bearer

Path parameters

jobIdstring required

Response

The job.

job_idstring

status'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled'

operation'frames' | 'transcript'

detailstring nullable

queuestring

credits_chargednumber nullable

cache_hitboolean

queued_atstring date-time

started_atstring date-time nullable

finished_atstring date-time nullable

Example response

{
  "error": {
    "reason": "no_video",
    "suggestion": {
      "session_id": "ses_01HZY6M8Q2"
    }
  }
}

Changes

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