Docs
Log inStart free
API referenceGenerations

Get a generation

Poll ONE credit-spending job by the generation_id the starting call returned (POST /media/generate, POST /scenes/{sceneId}/elements, …): status, error, and for an image the finished asset.

Poll ONE credit-spending job by the generation_id the starting call returned (POST /media/generate, POST /scenes/{sceneId}/elements, …): status, error, and for an image the finished asset. GET /projects/{id}/resolution answers for a whole project; this is the per-job receipt. 404 (not 403) when not accessible. wait (seconds, ≤ 120) holds the answer until the job is completed or failed, or the wait is up — one call instead of a poll loop.

GET
/generations/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

Typecut API key. Generate one in app.typecut.ai → Settings → API keys. Send as Authorization: Bearer tc_live_….

In: header

Path Parameters

id*string
Formatuuid

Query Parameters

wait?|

Seconds to wait for a finished or failed status (max 120).

Range0 <= value <= 120

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/generations/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "string",
    "status": "string",
    "error": "string",
    "credits": 0,
    "charged_credits": 0,
    "scenes_rendered": 0,
    "scenes_total": 0,
    "scenes_cached": 0,
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "scene_id": "861eef56-1159-4a95-802f-abab2d0cc192",
    "output_url": "string",
    "created_at": "string",
    "started_at": "string",
    "completed_at": "string",
    "image": {
      "asset_id": "b4695157-0d1d-4da0-8f9e-5c53149389e4",
      "url": "string",
      "width": 0,
      "height": 0,
      "description": "string"
    },
    "result": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}

A picture of an analysed source at any time, width and crop GET

One hosted JPEG per requested time of the analysed source: "the reference at 47.3 s, 640 wide, the lower third" without re-sensing a window.

Cancel a running generation POST

Stop a render-project job (more job types later; others answer 422).