Return the caller's account: identity, plan, entitlements, cost ceilings
Returns the org this key is bound to (server-resolved from auth, never the body), the current plan, a per-feature `entitlements` map, and `costCeilings` (e.g. the generate_media per-call USD ceiling). Read it BEFORE a metered call (create_render / compose / generate_media / create_brand_kit) to budget without burning a round-trip on a 402. READ `balance`, NOT `included`: most capabilities are credit-funded — rendering, generation, previews, the judge and the Director carry no separate per-plan allowance and instead spend the shared wallet named in `fundedBy`, so each `balance` is that one wallet restated in the feature's own `unit`. A positive balance means the call will go through; `included:false` means the plan genuinely lacks the feature. Plan/entitlement values come from the billing backend best-effort; unknown values are `null` and `billingConfigured:false` flags an environment where billing isn't configured.
API key auth. Prefix cf_live_ for production orgs, cf_test_ for sandbox.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/me"{ "orgId": "string", "displayName": "string", "plan": { "id": "string", "name": "string" }, "entitlements": { "property1": { "featureId": "string", "name": "string", "type": "metered", "unit": "cents", "included": true, "unlimited": true, "balance": 0, "includedUsage": 0, "usage": 0, "nextResetAt": 0, "fundedBy": "string", "creditCost": 0 }, "property2": { "featureId": "string", "name": "string", "type": "metered", "unit": "cents", "included": true, "unlimited": true, "balance": 0, "includedUsage": 0, "usage": 0, "nextResetAt": 0, "fundedBy": "string", "creditCost": 0 } }, "gateway": { "url": "string", "apiKey": "string" }, "costCeilings": { "generateMediaUsdPerCall": 0 }, "billingConfigured": true}{ "error": { "code": "string", "message": "string", "details": { "property1": null, "property2": null } }}{ "x402Version": 2, "accepts": [ {} ], "error": "string"}{ "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 } }}Mint a workspace (project + imported source) in one call POST
The one-call editing handle: create a project and import the source video URL into it. Returns { projectId, mediaId, importWorkflowId } — the handle a (paying or keyed) agent threads through the compose/render loop. The import is async; poll GET /v1/media/:mediaId for readiness.
Read the org's Profile — its legible taste GET
One read for everything the platform knows about this org's taste: brand kits, registered critics (the machine-checkable standard both the Director's gates and score_composition enforce), the critics' reference media with presigned thumbnails, and the recent checkpoint-decision log (what was approved/revised/abandoned, where). Read this before composing for an org you haven't worked with — it is the house style.