Skip to main content

Documentation Index

Fetch the complete documentation index at: https://acme-3f0e8fe2.mintlify.app/llms.txt

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

A render is a job that produces an image or a video by applying modifications to a published template.

Lifecycle

pending → rendering → completed
                    ↘ failed
StatusMeaning
pendingQueued, waiting for a worker
renderingWorker is producing the output
completedresult_url is populated
failederror field has the cause

Fields

FieldDescription
idRender identifier (img_<uuid> or vid_<uuid>)
template_idTemplate used
template_versionPinned version number
statusSee lifecycle above
result_urlSigned download URL (1h TTL, regenerated on read)
thumbnail_urlPreview image (videos only)
duration_msTotal render time
webhook_urlOptional callback once completed
created_atISO-8601 timestamp
result_url is signed and expires after 1 hour. Re-fetch the render to get a fresh URL — Imtegrate regenerates it on the fly from the underlying storage path.

Image vs video

  • Images — single PNG/JPEG, render in seconds
  • Videos — MP4 with thumbnail, can take minutes depending on duration
Endpoints: POST /v1/images, POST /v1/videos.

Webhooks vs polling

For high-volume integrations, prefer webhooks (guide). For one-off scripts, polling GET /v1/images/<id> is fine.