Get a job

GET

/v1/jobs/{id}

The job — status, timings, result.files or error. Add ?wait=N (≤ 60 s) to long-poll: the call returns as soon as the job is final, or after N seconds with its current state. A key only sees jobs it created.

Authorizations

apiKey

An API key from the console (API keys). Only its SHA-256 is stored; it is shown once.

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

string

Required

Example"job_01K7Z3Q4N5P6R7S8T9V0W1X2Y3"

Query Parameters

wait

Long-poll: hold the request up to this many seconds until the job is final.

Type

integer

Minimum

0

Maximum

60

Default

0

Responses

The job (in any state).

Content-Type

application/json

{

  

"id": "job_01K7Z3Q4N5P6R7S8T9V0W1X2Y3",

  

"object": "job",

  

"utility": "html-pdf",

  

"mode": "async",

  

"status": "succeeded",

  

"createdAt": "2026-09-10T17:30:08.412Z",

  

"startedAt": "2026-09-10T17:30:08.412Z",

  

"finishedAt": "2026-09-10T17:30:10.771Z",

  

"timings": {

  

  

"queueMs": 0,

  

  

"upstreamMs": 2140,

  

  

"storageMs": 196,

  

  

"totalMs": 2359

  

},

  

"metadata": {

  

  

"orderId": "ORD-1042"

  

},

  

"result": {

  

  

"files": [

  

  

  

{

  

  

  

  

"url": "https://files.servicelabs.dev/html-pdf/2026-09-10/job_01K7Z3Q4N5P6R7S8T9V0W1X2Y3/20260910173009_22d0cf84ca.pdf",

  

  

  

  

"key": "html-pdf/2026-09-10/job_01K7Z3Q4N5P6R7S8T9V0W1X2Y3/20260910173009_22d0cf84ca.pdf",

  

  

  

  

"name": "20260910173009_22d0cf84ca.pdf",

  

  

  

  

"size": 115741,

  

  

  

  

"contentType": "application/pdf"

  

  

  

}

  

  

]

  

},

  

"error": null,

  

"callback": null,

  

"links": {

  

  

"self": "/v1/jobs/job_01K7Z3Q4N5P6R7S8T9V0W1X2Y3"

  

}

}

GET

/v1/jobs/{id}

Playground

Authorization

apiKey

Variables

Key

Value

id*

wait

Samples

Powered by VitePress OpenAPI