CueFrame

Validate a composition body without saving it (dry-run)

POST
/v1/composition/validate

Authorization

AuthorizationBearer <token>

API key auth. Prefix cf_live_ for production orgs, cf_test_ for sandbox.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Canonical composition wire shape (multi-track; carries reframe, captions, markers).

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/composition/validate" \  -H "Content-Type: application/json" \  -d '{    "v": 1,    "format": {      "aspectRatio": "16:9"    },    "tracks": [      {        "id": "string",        "kind": "video",        "contents": [          {            "id": "string",            "startTime": 0,            "duration": 1,            "source": {              "kind": "media",              "mediaId": "string"            }          }        ]      }    ]  }'
{  "valid": true,  "errors": [    {      "code": "string",      "stage": "string",      "category": "string",      "retryable": true,      "message": "string",      "fix": {        "property1": null,        "property2": null      }    }  ]}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}