Skip to main content
GET
/
api
/
v1
/
dev
/
render
/
{jobId}
Get render job status
curl --request GET \
  --url https://api.autype.com/api/v1/dev/render/{jobId} \
  --header 'X-API-Key: <api-key>'
{
  "jobId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "downloadUrl": "<string>",
  "filename": "<string>",
  "error": "<string>",
  "completedAt": "2023-11-07T05:31:56Z",
  "progress": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.autype.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API Key (starts with ak_...)

Path Parameters

​
jobId
string
required

Response

Render job status

​
jobId
string
required

Render job ID

​
status
enum<string>
required

Current job status

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
​
format
enum<string>
required

Output format

Available options:
PDF,
DOCX,
ODT
​
createdAt
string<date-time>
required

Job creation timestamp

​
downloadUrl
string

Autype API download URL with signed token (only when completed). Alternatively use GET /render/{jobId}/download with API key.

​
filename
string

Filename for download

​
error
string

Error message if failed

​
completedAt
string<date-time>

Job completion timestamp

​
progress
number

Processing progress (0-100)