CueFrame Workspace API
One-call editing handle: mint a project + import its source URL in a single request.
One-call editing handle: mint a project + import its source URL in a single request.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.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.curl "https://apis.io/api/v1/apis/cueframe-ai:cueframe-ai-workspace-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
openapi: 3.2.0
info:
title: Cueframe Ai Workspace API
version: v1
contact:
name: CueFrame
url: https://cueframe.ai
email: support@cueframe.ai
license:
name: Apache-2.0
identifier: Apache-2.0
description: 'Operations tagged workspace across 2 of this provider''s published API definitions: cueframe-ai-openapi.json, cueframe-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.cueframe.ai
description: Production
tags:
- name: Workspace
description: 'One-call editing handle: mint a project + import its source URL in a single request.'
paths:
/v1/workspace:
post:
operationId: createWorkspace
tags:
- Workspace
summary: Mint a workspace (project + imported source) in one call
description: 'The one-call editing handle: create a project and import the source video URL into it. Returns { projectId, mediaId } — the handle a (paying or keyed) agent threads through the compose/render loop. The import is async; poll GET /v1/media/:mediaId for readiness.'
security:
- bearerAuth: []
- oauth2:
- projects:write
- media:write
- x402: []
x-permissions:
projects:
- write
media:
- write
x-x402:
amount: '20000'
deliverable: true
maxTimeoutSeconds: 900
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WorkspaceCreateRequest'
responses:
'202':
description: Workspace minted; source import enqueued.
content:
application/json:
schema:
type: object
properties:
projectId:
type: string
mediaId:
type: string
required:
- projectId
- mediaId
additionalProperties: false
'400':
description: Bad request — validation_error / invalid_cursor / invalid_query.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'401':
description: Missing or invalid Authorization header.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'402':
description: 'Payment required. Returned when the caller presents no API key on a priced operation: the body AND the `Payment-Required` header carry the x402 v2 challenge (accepted scheme, network, USDC asset, amount, payTo). Sign the EIP-3009 authorization and retry with a `PAYMENT-SIGNATURE` header. A KEYED caller sees this status instead when their plan lacks or has exhausted the feature (`billing_required`).'
headers:
Payment-Required:
description: Base64 x402 v2 PaymentRequired envelope — the same challenge as the body, for clients that read it off the header.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/X402PaymentRequired'
'403':
description: Forbidden — permission insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'422':
description: Unprocessable — invalid_composition / media_in_use / session_in_use / render_not_cancellable.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'429':
description: Rate limited. Retry-After header present.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'500':
description: Internal error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'503':
description: Service unavailable — billing_unavailable / honest-503 for runtime deps.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
x-payment-info:
price:
mode: fixed
currency: USD
amount: '0.02'
protocols:
- x402: {}
servers:
- url: https://api.cueframe.ai
description: Production
components:
schemas:
Format:
type: object
properties:
aspectRatio:
type: string
enum:
- '16:9'
- '9:16'
- '1:1'
- '4:5'
fps:
anyOf:
- type: number
const: 24
- type: number
const: 25
- type: number
const: 30
- type: number
const: 60
resolution:
type: string
enum:
- hd
- fhd
- 4k
platform:
type: string
required:
- aspectRatio
X402PaymentRequired:
type: object
title: X402PaymentRequired
description: x402 v2 PaymentRequired challenge — the body of a 402 on a priced operation.
properties:
x402Version:
type: integer
const: 2
accepts:
type: array
description: Accepted payment requirements. Read `accepts[0]` for scheme (`exact` for a fixed price, `upto` for a measured one), network (CAIP-2), asset, amount and payTo.
items:
type: object
error:
type: string
description: Human-readable reason.
required:
- x402Version
- accepts
WorkspaceCreateRequest:
type: object
properties:
videoUrl:
type: string
maxLength: 2048
format: uri
format:
$ref: '#/components/schemas/Format'
required:
- videoUrl
additionalProperties: false
example:
videoUrl: https://example.com/talk.mp4
ErrorEnvelope:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code per §Error Model.
message:
type: string
description: Human-readable message.
contract:
type: string
description: Contract version that produced this verdict. If it differs between two calls, the rules changed underneath you, not your request.
contractVersion:
type: string
description: 'Version of the published `@cueframe/api-contract` this server implements. Compare it with the `contractVersion` of the package your client was generated from: a higher value here means the server has moved ahead of your document.'
details:
description: Optional context (currentEtag, projectIds, retryAfter, …).
type: object
propertyNames:
type: string
additionalProperties: {}
required:
- code
- message
- contract
- contractVersion
description: Standard API error envelope.
required:
- error
description: Error envelope used by every non-2xx response.
securitySchemes:
oauth2:
type: oauth2
description: Authorization code with PKCE (S256). Request explicit resource scopes for least privilege; identity-only grants retain account-level access.
flows:
authorizationCode:
authorizationUrl: https://api.cueframe.ai/api/auth/mcp/authorize
tokenUrl: https://api.cueframe.ai/api/auth/mcp/token
scopes:
media:read: Read media
media:write: Modify media
sessions:read: Read sessions
sessions:write: Modify sessions
projects:read: Read projects
projects:write: Modify projects
renders:read: Read renders
renders:write: Modify renders
webhooks:read: Read webhooks
webhooks:write: Modify webhooks
billing:read: Read billing
billing:write: Modify billing
bearerAuth:
type: http
scheme: bearer
bearerFormat: cf_live_* or cf_test_*
description: API key auth. Prefix `cf_live_` for production orgs, `cf_test_` for sandbox.
x402:
type: apiKey
in: header
name: PAYMENT-SIGNATURE
description: x402 v2 payment header (EIP-3009 USDC on Base; base64 PaymentPayload). Returned 402 Payment-Required if absent on priced endpoints.
x-refined-from:
- cueframe-ai-openapi.json
- cueframe-ai-openapi.yml