CueFrame · Schema

CompositionReplaceRequest

CompanyVideoVideo EditingVideo RenderingAI AgentsMCPMediaDeveloper Tools
View JSON Schema on GitHub

JSON Schema

cueframe-ai-composition-replace-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cueframe-ai/json-schema/cueframe-ai-composition-replace-request-schema.json",
  "title": "CompositionReplaceRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cueframe-ai-compositions-api-openapi.yml#/components/schemas/CompositionReplaceRequest",
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "composition": {
          "$ref": "#/$defs/Composition"
        },
        "componentExecutionVersions": {
          "anyOf": [
            {
              "type": "array",
              "prefixItems": [
                {
                  "type": "number",
                  "const": 3
                }
              ],
              "items": false,
              "minItems": 1,
              "maxItems": 1
            },
            {
              "type": "array",
              "prefixItems": [
                {
                  "type": "number",
                  "const": 3
                },
                {
                  "type": "number",
                  "const": 4
                }
              ],
              "items": false,
              "minItems": 2,
              "maxItems": 2
            }
          ]
        },
        "builtinSources": {
          "minItems": 1,
          "maxItems": 512,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "scope": {
                "type": "object",
                "properties": {
                  "kind": {
                    "type": "string",
                    "const": "builtin"
                  },
                  "collection": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 256
                  }
                },
                "required": [
                  "kind",
                  "collection"
                ],
                "additionalProperties": false
              },
              "componentId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 256
              },
              "sourceVersionId": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "sourceVersion": {
                "anyOf": [
                  {
                    "type": "number",
                    "const": 3
                  },
                  {
                    "type": "number",
                    "const": 4
                  }
                ]
              }
            },
            "required": [
              "scope",
              "componentId",
              "sourceVersionId",
              "sourceVersion"
            ],
            "additionalProperties": false
          }
        },
        "expectedBrandIdentity": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        }
      },
      "required": [
        "composition",
        "componentExecutionVersions"
      ],
      "additionalProperties": false
    },
    {
      "$ref": "#/$defs/Composition"
    }
  ],
  "$defs": {
    "ComponentExecutionRef": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "version": {
              "type": "number",
              "const": 3
            },
            "componentId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 256
            },
            "sourceVersionId": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            "params": {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {
                "$ref": "#/$defs/ComponentParameterValue"
              }
            },
            "seed": {
              "type": "string",
              "minLength": 1
            },
            "assets": {
              "type": "object",
              "propertyNames": {
                "type": "string",
                "minLength": 1,
                "maxLength": 256
              },
              "additionalProperties": {
                "type": "string",
                "minLength": 1
              }
            },
            "mediaBindings": {
              "type": "object",
              "propertyNames": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              },
              "additionalProperties": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 128
                }
              }
            }
          },
          "required": [
            "version",
            "componentId",
            "sourceVersionId",
            "params",
            "seed"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "version": {
              "type": "number",
              "const": 4
            },
            "componentId": {
              "type": "string",
              "minLength": 1,
              "maxLength": 256
            },
            "sourceVersionId": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            "params": {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {
                "$ref": "#/$defs/ComponentParameterValue"
              }
            },
            "seed": {
              "type": "string",
              "minLength": 1
            },
            "assets": {
              "type": "object",
              "propertyNames": {
                "type": "string",
                "minLength": 1,
                "maxLength": 256
              },
              "additionalProperties": {
                "type": "string",
                "minLength": 1
              }
            },
            "mediaBindings": {
              "type": "object",
              "propertyNames": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128
              },
              "additionalProperties": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 128
                }
              }
            }
          },
          "required": [
            "version",
            "componentId",
            "sourceVersionId",
            "params",
            "seed"
          ],
          "additionalProperties": false
        }
      ]
    },
    "ComponentParameterValue": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ComponentParameterValue"
          }
        },
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ComponentParameterValue"
          }
        }
      ]
    },
    "Composition": {
      "type": "object",
      "properties": {
        "v": {
          "type": "number",
          "const": 1
        },
        "format": {
          "$ref": "#/$defs/Format"
        },
        "tracks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1
              },
              "kind": {
                "type": "string",
                "enum": [
                  "video",
                  "audio",
                  "image",
                  "overlay",
                  "effect"
                ]
              },
              "name": {
                "type": "string"
              },
              "enabled": {
                "type": "boolean"
              },
              "volume": {
                "type": "number",
                "minimum": 0,
                "maximum": 4
              },
              "contents": {
                "type": "array",
                "items": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/TimelineClip"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "minLength": 1
                        },
                        "startTime": {
                          "type": "number",
                          "minimum": 0
                        },
                        "duration": {
                          "type": "number",
                          "exclusiveMinimum": 0
                        }
                      },
                      "required": [
                        "id",
                        "startTime",
                        "duration"
                      ],
                      "additionalProperties": false
                    }
                  ]
                }
              }
            },
            "required": [
              "id",
              "kind",
              "contents"
            ],
            "additionalProperties": false
          }
        },
        "markers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1
              },
              "startTime": {
                "type": "number",
                "minimum": 0
              },
              "endTime": {
                "type": "number",
                "minimum": 0
              },
              "kind": {
                "type": "string",
                "minLength": 1
              },
              "name": {
                "type": "string"
              },
              "metadata": {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              }
            },
            "required": [
              "id",
              "startTime",
              "kind"
            ],
            "additionalProperties": false
          }
        },
        "captions": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "source": {
                  "type": "string",
                  "const": "derived"
                },
                "from": {
                  "type": "object",
                  "properties": {
                    "clipId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "clipId"
                  ]
                },
                "segments": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "words": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "text": {
                              "type": "string",
                              "minLength": 1
                            },
                            "startMs": {
                              "type": "number",
                              "minimum": 0,
                              "description": "Word start on the composition timeline, in milliseconds."
                            },
                            "endMs": {
                              "type": "number",
                              "minimum": 0,
                              "description": "Word end on the composition timeline, in milliseconds."
                            },
                            "emphasis": {
                              "type": "boolean"
                            },
                            "annotate": {
                              "type": "string",
                              "enum": [
                                "circle",
                                "underline"
                              ]
                            }
                          },
                          "required": [
                            "text",
                            "startMs",
                            "endMs"
                          ]
                        }
                      }
                    },
                    "required": [
                      "words"
                    ]
                  }
                },
                "style": {
                  "type": "object",
                  "properties": {
                    "fontFamily": {
                      "type": "string",
                      "minLength": 1
                    },
                    "fontSize": {
                      "description": "Font size as % of composition height (1-15, default 5). NOT px.",
                      "type": "number",
                      "minimum": 1,
                      "maximum": 15
                    },
                    "fontWeight": {
                      "type": "integer",
                      "minimum": 100,
                      "maximum": 900
                    },
                    "color": {
                      "type": "string",
                      "minLength": 1
                    },
                    "highlightColor": {
                      "type": "string",
                      "minLength": 1
                    },
                    "backgroundColor": {
                      "type": "string"
                    },
                    "plate": {
                      "type": "string",
                      "enum": [
                        "glass",
                        "solid",
                        "none"
                      ]
                    },
                    "position": {
                      "type": "string",
                      "enum": [
                        "top",
                        "center",
                        "bottom"
                      ]
                    },
                    "region": {
                      "description": "Optional caption layout box {x,y,w,h} in normalized output-frame coordinates. Overrides position; text starts at its top edge and wraps/pages within its width and height.",
                      "type": "object",
                      "properties": {
                        "x": {
                          "type": "number",
                          "minimum": 0,
                          "maximum": 1
                        },
                        "y": {
                          "type": "number",
                          "minimum": 0,
                          "maximum": 1
                        },
                        "w": {
                          "type": "number",
                          "exclusiveMinimum": 0,
                          "maximum": 1
                        },
                        "h": {
                          "type": "number",
                          "exclusiveMinimum": 0,
                          "maximum": 1
                        }
                      },
                      "required": [
                        "x",
                        "y",
                        "w",
                        "h"
                      ]
                    },
                    "textTransform": {
                      "type": "string",
                      "enum": [
                        "none",
                        "uppercase",
                        "capitalize"
                      ]
                    },
                    "letterSpacing": {
                      "description": "Base caption glyph spacing in pixels.",
                      "type": "number",
                      "minimum": -5,
                      "maximum": 20
                    },
                    "wordGapEm": {
                      "description": "Gap between caption runs as a multiple of base font size; default 0.35.",
                      "type": "number",
                      "minimum": 0,
                      "maximum": 2
                    },
                    "lineGapEm": {
                      "description": "Gap between caption lines as a multiple of base font size; default 0.25.",
                      "type": "number",
                      "minimum": 0,
                      "maximum": 2
                    },
                    "emphasisColor": {
                      "type": "string"
                    },
                    "emphasisGradient": {
                      "type": "string"
                    },
                    "emphasisScale": {
                      "type": "number",
                      "exclusiveMinimum": 0
                    },
                    "emphasisFontFamily": {
                      "type": "string"
                    },
                    "emphasisFontWeight": {
                      "type": "integer",
                      "minimum": 100,
                      "maximum": 900
                    },
                    "emphasisTextTransform": {
                      "type": "string",
                      "enum": [
                        "none",
                        "uppercase",
                        "capitalize"
                      ]
                    },
                    "emphasisLetterSpacing": {
                      "type": "number"
                    },
                    "emphasisFontStyle": {
                      "type": "string",
                      "enum": [
                        "normal",
                        "italic"
                      ]
                    },
                    "entrance": {
                      "type": "string",
                      "enum": [
                        "none",
                        "fade",
                        "word-pop",
                        "stagger-up"
                      ]
                    },
                    "entranceMs": {
                      "type": "number",
                      "minimum": 0
                    },
                    "entranceStaggerMs": {
                      "type": "number",
                      "minimum": 0
                    },
                    "exitMs": {
                      "type": "number",
                      "minimum": 0
                    },
                    "emphasisPlate": {
                      "type": "boolean"
                    },
                    "emphasisPlateColor": {
                      "type": "string"
                    },
                    "emphasisPlateTextColor": {
                      "type": "string"
                    },
                    "emphasisPlateAltColor": {
                      "type": "string"
                    },
                    "emphasisPlateAltTextColor": {
                      "type": "string"
                    },
                    "emphasisPlateRadius": {
                      "type": "number",
                      "minimum": 0
                    },
                    "emphasisPlatePadX": {
                      "type": "number"
                    },
                    "emphasisPlatePadY": {
                      "type": "number"
                    },
                    "emphasisPlateReveal": {
                      "description": "Grow a shared emphasis plate as saved words appear while reserving its final layout width.",
                      "type": "boolean"
                    },
                    "annotationColor": {
                      "type": "string"
                    },
                    "annotationStrokeWidth": {
                      "description": "Annotation stroke width in its 100×100 SVG coordinate system; default 4.",
                      "type": "number",
                      "minimum": 0.5,
                      "maximum": 12
                    },
                    "annotationTexture": {
                      "description": "Native annotation stroke finish; default clean.",
                      "type": "string",
                      "enum": [
                        "clean",
                        "pencil"
                      ]
                    },
                    "maxWidthPercent": {
                      "type": "number",
                      "exclusiveMinimum": 0,
                      "maximum": 100
                    }
                  }
                },
                "layouts": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "segmentIndex": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      "wordStartIndex": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      "wordEndIndex": {
                        "type": "integer",
                        "exclusiveMinimum": 0,
                        "maximum": 9007199254740991,
                        "description": "Exclusive word index in the saved caption segment."
                      },
                      "region": {
                        "type": "object",
                        "properties": {
                          "x": {
                            "type": "number",
                            "minimum": 0,
                            "maximum": 1
                          },
                          "y": {
                            "type": "number",
                            "minimum": 0,
                            "maximum": 1
                          },
                          "w": {
                            "type": "number",
                            "exclusiveMinimum": 0,
                            "maximum": 1
                          },
                          "h": {
                            "type": "number",
                            "exclusiveMinimum": 0,
                            "maximum": 1
                          }
                        },
                        "required": [
                          "x",
                          "y",
                          "w",
                          "h"
                        ]
                      },
                      "scale": {
                        "type": "number",
                        "minimum": 0.25,
                        "maximum": 4
                      },
                      "rotation": {
                        "type": "number",
                        "minimum": -45,
                        "maximum": 45
                      },
                      "style": {
                        "type": "object",
                        "properties": {
                          "fontFamily": {
                            "type": "string",
                            "minLength": 1
                          },
                          "fontSize": {
                            "description": "Font size as % of composition height (1-15, default 5). NOT px.",
                            "type": "number",
                            "minimum": 1,
                            "maximum": 15
                          },
                          "fontWeight": {
                            "type": "integer",
                            "minimum": 100,
                            "maximum": 900
                          },
                          "color": {
                            "type": "string",
                            "minLength": 1
                          },
                          "highlightColor": {
                            "type": "string",
                            "minLength": 1
                          },
                          "backgroundColor": {
                            "type": "string"
                          },
                          "plate": {
                            "type": "string",
                            "enum": [
                              "glass",
                              "solid",
                              "none"
                            ]
                          },
                          "textTransform": {
                            "type": "string",
                            "enum": [
                              "none",
                              "uppercase",
                              "capitalize"
                            ]
                          },
                          "letterSpacing": {
                            "description": "Base caption glyph spacing in pixels.",
                            "type": "number",
                            "minimum": -5,
                            "maximum": 20
                          },
                          "wordGapEm": {
                            "description": "Gap between caption runs as a multiple of base font size; default 0.35.",
                            "type": "number",
                            "minimum": 0,
                            "maximum": 2
                          },
                          "lineGapEm": {
                            "description": "Gap between caption lines as a multiple of base font size; default 0.25.",
                            "type": "number",
                            "minimum": 0,
                            "maximum": 2
                          },
                          "emphasisColor": {
                            "type": "string"
                          },
                          "emphasisScale": {
                            "type": "number",
                            "exclusiveMinimum": 0
                          },
                          "emphasisFontFamily": {
                            "type": "string"
                          },
                          "emphasisFontWeight": {
                            "type": "integer",
                            "minimum": 100,
                            "maximum": 900
                          },
                          "emphasisTextTransform": {
                            "type": "string",
                            "enum": [
                              "none",
                              "uppercase",
                              "capitalize"
                            ]
                          },
                          "emphasisLetterSpacing": {
                            "type": "number"
                          },
                          "emphasisFontStyle": {
                            "type": "string",
                            "enum": [
                              "normal",
                              "italic"
                            ]
                          },
                          "emphasisPlate": {
                            "type": "boolean"
                          },
                          "emphasisPlateColor": {
                            "type": "string"
                          },
                          "emphasisPlateTextColor": {
                            "type": "string"
                          },
                          "emphasisPlateAltColor": {
                            "type": "string"
                          },
                          "emphasisPlateAltTextColor": {
                            "type": "string"
                          },
                          "emphasisPlateRadius": {
                            "type": "number",
                            "minimum": 0
                          },
                          "emphasisPlatePadX": {
                            "type": "number"
                          },
                          "emphasisPlatePadY": {
                            "type": "number"
                          },
                          "emphasisPlateReveal": {
                            "description": "Grow a shared emphasis plate as saved words appear while reserving its final layout width.",
                            "type": "boolean"
                          },
                          "annotationColor": {
                            "type": "string"
                          },
                          "annotationStrokeWidth": {
                            "description": "Annotation stroke width in its 100×100 SVG coordinate system; default 4.",
                            "type": "number",
                            "minimum": 0.5,
                            "maximum": 12
                          },
                          "annotationTexture": {
                            "description": "Native annotation stroke finish; default clean.",
                            "type": "string",
                            "enum": [
                              "clean",
                              "pencil"
                            ]
                          },
                          "entrance": {
                            "type": "string",
                            "enum": [
                              "none",
                              "fade",
                              "word-pop",
                              "stagger-up"
                            ]
                          },
                          "entranceMs": {
                            "type": "number",
                            "minimum": 0
                          },
                          "entranceStaggerMs": {
                            "type": "number",
                            "minimum": 0
                          },
                          "exitMs": {
                            "type": "number",
                            "minimum": 0
                          }
                        },
                        "additionalProperties": false
                      },
                      "holdThroughWordIndex": {
                        "description": "Inclusive saved-word index in this segment. The layout stays visible until that word ends.",
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      "wordMarks": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "wordIndex": {
                              "type": "integer",
                              "minimum": 0,
                              "maximum": 9007199254740991
                            },
                            "emphasis": {
                              "type": "boolean"
                            },
                            "annotate": {
                              "anyOf": [
                                {
                                  "type": "string",
                                  "enum": [
                                    "circle",
                                    "underline"
                                  ]
                                },
                                {
                                  "type": "null"
                                }
                              ]
                            }
                          },
                          "required": [
                            "wordIndex"
                          ],
                          "additionalProperties": false
                        }
                      },
                      "wordSignature": {
                        "type": "string",
                        "pattern": "^[a-f0-9]{64}$"
                      }
                    },
                    "required": [
                      "segmentIndex",
                      "wordStartIndex",
                      "wordEndIndex",
                      "region",
                      "wordSign

# --- truncated at 32 KB (101 KB total) ---
# Full source: https://artifacts.apis.io/cueframe-ai/json-schema/cueframe-ai-composition-replace-request-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/cueframe-ai-composition-replace-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.