v1

latestOpenAPI 3.1.02026-08-06244570.4 KB

Agent

Get authoring-agent job status

Poll the status of an authoring-agent job.

Authentication: API Key required (x-api-key header)

Status	Description
pending	Job is queued
processing	The agent is authoring (typically 30s-3min)
completed	Done — template_id and preview_url are set
failed	Job failed (see error_message); credits were refunded

Poll every 2-5 seconds. A job stuck in processing for more than 10 minutes is failed automatically and its credits refunded.

get/v1/agent/jobs/{job_id}

job_idstring required

Job UUID

Job status retrieved

idstring required

kind'create' | 'revise' required

status'pending' | 'processing' | 'completed' | 'failed' required

template_idstring nullable

Template short ID (once known)

preview_urlstring nullable

Signed URL of the rendered preview (set when completed)

preview_expires_atstring nullable

notesstring nullable

Agent notes: font substitutions, naming, layout choices

credits_chargedinteger required

error_messagestring nullable

error_codestring nullable

created_atstring required

updated_atstring required

completed_atstring nullable