CueFrame

Create Render

create_render

Queue an MP4 render of a project's composition. Returns { id (renderId), status, warnings? } — warnings[] carries non-fatal advisories (omitted when none). The render themes from the project's brand kit (bind one via create_project / update_project with brandKitId — or PATCH /projects/:id over REST; without one the output is unbranded). Then call wait_job(kind="render", id=renderId, projectId=...) to block until the file is ready and get the download URL, or register a webhook (create_webhook on render.completed — status rides the payload).

Input Schema

TableJSON Schema

Name	Required	Description	Default
`body`	Yes	POST /projects/:id/renders body.
`projectId`	Yes	projectId (path).

Output Schema

TableJSON Schema

Name	Required	Description
`id`	No
`error`	No	Human-readable failure message. Pair with `errorCode` for a stable, machine-readable code an agent runner can branch on.
`engine`	No	The render engine the row was minted for. Null on rows minted before the engine was recorded.
`format`	No	The resolved output format the render was encoded at (aspectRatio, fps, resolution): the frozen composition's, after any create-time scale override. Null on legacy rows.
`status`	No
`listUsd`	No	A2 money stamp: the metered event's LIST price (USD), stamped at the success terminal (exports for deliverable renders, compose_capture for A8 previews). A plan allowance may zero the actual invoice line — this is the list price, never a Stripe charge. Absent while running, on failure, and for x402 orgs (on-chain receipts). Mirrors the get_usage ledger.
`preview`	No	The scoped preview window when this is a preview_clip render; null for a full deliverable.
`category`	No	Failure taxonomy when status is `error`; null otherwise. `authoring` = deterministic defect in YOUR composition/request — fix it, retrying is futile; `transient` = temporary pipeline/infra failure — safe to retry_render; `internal` = unexpected server fault — retry once then escalate. Mirrors the render.failed webhook's `category`.
`progress`	No	Non-terminal render progress; phase is one of the worker's emitted stages.
`warnings`	No	Non-fatal advisories surfaced at render-CREATE (omitted when none, and on GET — create-time only).
`createdAt`	No
`errorCode`	No	Stable, machine-readable error code (e.g. `render_pipeline_unavailable`, `render_route_missing`, `render_pipeline_failed`). Null when status is not `error` or unavailable for an older render.
`outputUrl`	No
`retryable`	No	Whether re-attempting the SAME render can succeed (status `error`); null otherwise. true → call retry_render. false → deterministic (category authoring/internal); fix the composition first — retry_render alone reproduces it. Mirrors the render.failed webhook's `retryable`.
`updatedAt`	No	ISO-8601 timestamp of the render's most recent progress update. Compute staleness = now − updatedAt to distinguish a wedged render from a slow one and decide whether to wait, cancel, or retry.
`completedAt`	No	ISO-8601 instant the render reached its terminal status (complete, error or cancelled); null while it runs. Pair with createdAt for the wall time.
`errorDetails`	No	Structured failure context — `{ targetUrl?, upstreamStatus?, upstreamCode?, attemptedAt? }`. Surfaced so agent runners can distinguish operator-config issues from upstream-down vs route-missing without parsing `error`.
`compositionId`	No	The composition this render froze at create time (the project's active one, or the compositionId the request named). Null on renders minted before this was recorded.
`outputExpiresAt`	No
`outputDurationSec`	No	The output's length in seconds (the composition timeline's, or the preview window's), as billed. Null on legacy rows.

Schema Changelog

Changes observed during successful MCP inspections.

Changed7 schema fields changedOct 18, 2026

changedInput schema / properties / body / properties / format / additionalProperties
```
Previous value: -falseNew value: +{}
```

addedOutput schema / properties / completedAt

Added value: +{
+  "description": "ISO-8601 instant the render reached its terminal status (complete, error or cancelled); null while it runs. Pair with createdAt for the wall time.",
+  "type": [
+    "string",
+    "null"
+  ]
+}

addedOutput schema / properties / compositionId

Added value: +{
+  "description": "The composition this render froze at create time (the project's active one, or the compositionId the request named). Null on renders minted before this was recorded.",
+  "type": [
+    "string",
+    "null"
+  ]
+}

addedOutput schema / properties / engine

Added value: +{
+  "description": "The render engine the row was minted for. Null on rows minted before the engine was recorded."
+}

addedOutput schema / properties / format

Added value: +{
+  "description": "The resolved output format the render was encoded at (aspectRatio, fps, resolution): the frozen composition's, after any create-time scale override. Null on legacy rows."
+}

addedOutput schema / properties / outputDurationSec

Added value: +{
+  "description": "The output's length in seconds (the composition timeline's, or the preview window's), as billed. Null on legacy rows.",
+  "type": [
+    "number",
+    "null"
+  ]
+}

addedOutput schema / properties / preview

Added value: +{
+  "description": "The scoped preview window when this is a preview_clip render; null for a full deliverable."
+}

Changed2 schema fields changedOct 15, 2026
- removedInput schema / properties / body / properties / format / description
```
Removed value: -"Output-format spec per §Format."
```
- addedInput schema / properties / body / properties / format / properties / platform
```
Added value: +{
+  "type": "string"
+}
```
First observedOct 10, 2026

TDQS

A4.3/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only declare readOnlyHint=false, idempotentHint=false, etc.; the description adds genuinely non-obvious behavior — the render themes from the bound brand kit and is unbranded without one, and warnings[] are non-fatal and omitted when empty. The return-shape restatement is partly redundant given an output schema exists, which keeps it from a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose, return shape, brand-kit dependency, and follow-up routing are front-loaded and each sentence carries information. The 'or PATCH /projects/:id over REST' aside is a minor piece of waste aimed at non-MCP callers.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an async, nested-body mutation tool, the description supplies the essential async handoff (wait_job/webhook), the brand-kit dependency, and the warning semantics. It omits failure/cancellation behavior and the meaning of the format/intent/priority knobs, but those gaps are largely covered by the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description only touches brandKitId in passing (bind via create_project/update_project) and says nothing about format, intent, priority, or clipSuggestionId, so it adds little beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening sentence names a specific verb ('Queue'), resource ('MP4 render'), and target ('a project's composition'), which cleanly separates it from get_render, cancel_render, retry_render, and refresh_render_url. An agent can identify the tool's role without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It lays out the full workflow with explicit alternatives and the condition that selects each: block via wait_job(kind="render", ...) or register a webhook via create_webhook on render.completed. It also notes the brand-kit prerequisite path (create_project / update_project with brandKitId) and the unbranded fallback, leaving little to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All CueFrame tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.