Jobs

GET

/v1/jobs/{id}

GET

/v1/jobs/{id}

Poll the status, progress (0–100) and result of a job started with is_async=true. Polling is free. Poll until status is terminal: CompletedJob, Error, NotFound or BadRequest.

Autorización

ApiKeyAuth

headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Parámetros de ruta

id*string

The job_id returned by an endpoint called with is_async=true.

Cuerpo de la respuesta

Job status, with the result once status is CompletedJob.

application/json

response

id?string

success?boolean|null

status?string

Value in"Queued""Running""CompletedJob""Error""NotFound""BadRequest"

endpoint?string

created_at?string

started_at?string|null

completed_at?string|null

duration_ms?number|null

args?

result?unknown

progress?integer|null

Example Request

curl -X GET 'https://api.capturekit.dev/v1/jobs/string'

Example Request

curl -X GET 'https://api.capturekit.dev/v1/jobs/string'

Example ResponseSchema

{
  "id": "string",
  "success": true,
  "status": "Queued",
  "endpoint": "string",
  "created_at": "string",
  "started_at": "string",
  "completed_at": "string",
  "duration_ms": 0,
  "args": {},
  "result": null,
  "progress": 0
}

{  "id": "string",  "success": true,  "status": "Queued",  "endpoint": "string",  "created_at": "string",  "started_at": "string",  "completed_at": "string",  "duration_ms": 0,  "args": {},  "result": null,  "progress": 0}

AutorizaciónCopiar enlace del ancla

Parámetros de rutaCopiar enlace del ancla

Cuerpo de la respuestaCopiar enlace del ancla

Autorización

Parámetros de ruta

Cuerpo de la respuesta