JsonCutDocs
V2 APIEndpointsRenders

Queue a render from the current or pinned project version

Queue a render from the current or pinned project version. Asynchronous project, template and inline render submission, status, cancellation and artifact access. Required API key scopes: `projects:read`, `renders:create`.

POST
/api/v2/projects/{id}/renders

Authorization

apiKeyAuth

Path Parameters

id*string

Resource identifier

Request Body

application/json

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v2/projects/string/renders" \  -H "Content-Type: application/json" \  -d '{    "kind": "image",    "format": "png",    "quality": "high",    "transparent": true,    "retention": "project"  }'
{  "success": true,  "data": {    "id": "render_01J",    "projectId": "project_01J",    "projectName": "Launch artwork",    "kind": "image",    "status": "queued",    "progress": 0,    "phase": "queued",    "queuePosition": 1,    "createdAt": "2026-08-25T09:15:00.000Z",    "format": "png",    "outputWidth": 1080,    "outputHeight": 1080,    "transparent": true  }}

Stream owned media with byte-range support for preview, playback or download GET

Stream owned media with byte-range support for preview, playback or download. Owned image, video, audio and font resources referenced by durable jsoncut-media URLs. Required API key scopes: `media:read`.

Queue a temporary-by-default render from an inline HTML source bundle POST

Queue a temporary-by-default render from an inline HTML source bundle. Asynchronous project, template and inline render submission, status, cancellation and artifact access. Required API key scopes: `renders:create`.