# PREVIZ for developers: the MCP server, client recipes and tool reference | AIM Previz

https://aimpreviz.com/developers

[Previz](https://aimpreviz.com/) / Developers

# PREVIZ for programs

Published 4 Nov 2026Updated 5 Nov 2026by the PREVIZ team

One MCP server at https://mcp.aimpreviz.com. Your agent or script acts as you, on your projects, through the same gated, metered functions the studio's buttons run.

## The address

Every client, every script and every recipe on these pages talks to this one address. Nothing else serves the door, and no client needs anything installed from PREVIZ.

Server address

https://mcp.aimpreviz.com

Streamable HTTP, JSON-RPC 2.0. Your key goes in the Authorization header as a bearer token.

Coming next: Claude.ai and Claude Desktop, which add a server from its address alone. You will add PREVIZ as a custom connector and approve it on a PREVIZ sign-in page — no key to paste. Until that opens, use a client that can send a key. A key holds only the access classes its owner gave it, set in Account → API keys → the key's Access: a new key holds read and write, and spend needs a monthly credit cap. tools/list shows only the tools a key holds, and a call to any other is refused with INSUFFICIENT_SCOPE. A key made before access classes existed keeps what it could do then (read, write, spend and live) until its owner sets its access; produce is given, never inherited.

Server PREVIZ 0.28.0 · protocol versions 2025-11-25 and 2025-06-18 · 102 tools.

## Quickstart

Five steps from no key to a first render, with nothing spent until the last one.

1. 01

   ### Mint a key

   Account → API keys. Give it a name and a monthly credit cap. It is shown once; keep it in an environment variable.
2. 02

   ### Connect a client

   Pick your client below. Every recipe sends the key as a bearer header to the same address.
3. 03

   ### Read first

   Ask for list_projects, then get_board on one of them. Reads are free and change nothing.
4. 04

   ### Price before you spend

   plan_quote prices a whole plan and reports anything the project's engine policy would refuse. Still free.
5. 05

   ### Spend on purpose

   Call a paid tool and it answers with its quote and a quoteToken, and runs nothing. Send it again with that token, or with your own idempotencyKey, and it renders once, inside the key's cap; a retry joins the same run and the work is charged once.

Your first call: list the projects this key can reach

```
curl -s https://mcp.aimpreviz.com \
  -H "Authorization: Bearer $PVZ_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call",
       "params":{"name":"list_projects","arguments":{}}}'
```

## Connect a client

One recipe per client: the config, how to check it worked, and what it cannot do. A client marked Not yet is not a promise of a date.

### Claude

- [Claude Code](https://aimpreviz.com/developers/connect/claude-code)

  Works today

  Works today with an API key in a header.
- [Claude.ai, Claude Desktop and Claude mobile](https://aimpreviz.com/developers/connect/claude-ai)

  Partly, today

  The custom connector needs PREVIZ's sign-in, which is not open yet. Claude Desktop can connect today through a local bridge that sends your key.
- [Claude API (Messages API connector)](https://aimpreviz.com/developers/connect/claude-api)

  Works today

  Works today: the connector sends your PREVIZ key as a bearer token.

### OpenAI

- [ChatGPT (apps and connectors)](https://aimpreviz.com/developers/connect/chatgpt)

  Not yet

  Not yet: ChatGPT's connectors take an address and a sign-in, not a key header, and PREVIZ's sign-in is not open yet.
- [OpenAI Responses API and Agents SDK](https://aimpreviz.com/developers/connect/openai)

  Works today

  Works today with an API key in a header.

### Editors

- [Cursor](https://aimpreviz.com/developers/connect/cursor)

  Works today

  Works today with an API key in a header.
- [VS Code and GitHub Copilot](https://aimpreviz.com/developers/connect/vscode)

  Works today

  Works today with an API key in a header.
- [Windsurf](https://aimpreviz.com/developers/connect/windsurf)

  Works today

  Works today with an API key in a header.
- [Cline](https://aimpreviz.com/developers/connect/cline)

  Works today

  Works today with an API key in a header.
- [Zed](https://aimpreviz.com/developers/connect/zed)

  Works today

  Works today with an API key in a header.

### Terminals

- [Gemini CLI and Google ADK](https://aimpreviz.com/developers/connect/gemini)

  Works today

  Works today with an API key in a header.
- [Codex CLI](https://aimpreviz.com/developers/connect/codex)

  Works today

  Works today with an API key read from an environment variable.

### Frameworks

- [LangChain and LlamaIndex](https://aimpreviz.com/developers/connect/langchain)

  Works today

  Works today with an API key in a header.

### Automation

- [n8n and Make](https://aimpreviz.com/developers/connect/n8n)

  Partly, today

  Works today over MCP with a key header; a REST mapping is not built yet, so a plain HTTP step sends JSON-RPC.

### Direct

- [curl, TypeScript and Python](https://aimpreviz.com/developers/connect/http)

  Works today

  Works today: one POST per call, JSON-RPC 2.0, your key in a header.

## Concepts

The five ideas the reference assumes you have.

- [Auth and keys](https://aimpreviz.com/developers/concepts/auth)

  How a program proves who it is to the PREVIZ door: a personal API key in a header today, what that key can reach, and how to bound it.
- [Quotes and money](https://aimpreviz.com/developers/concepts/money)

  How a paid PREVIZ tool answers with a quote and spends nothing, how its quote token or your own idempotency key turns it into exactly one charge, and what an agent can and cannot buy.
- [Projects and engine policy](https://aimpreviz.com/developers/concepts/policy)

  Why every PREVIZ call names a project, and how that project's engine policy decides which engines may touch the work before a credit moves.
- [Continuity](https://aimpreviz.com/developers/concepts/continuity)

  How PREVIZ holds a cast, a prop or a location faithful across every frame an agent renders, how a program reads the project's memory and its decisions, and how it re-shoots exactly what a changed decision made stale.
- [Jobs and events](https://aimpreviz.com/developers/concepts/jobs)

  Which PREVIZ tools answer at once and which start work that lands later, how to poll for it, and how one cursor watches every project.

## Tool reference

All 102 tools, by what they do. Each page gives its arguments, its answer, its access class, its live price and how it fails.

### Read

Projects, boards, the scene graph, locked identities, drift, provenance, footage, meshes and the look vocabulary. Free, exact, nothing inferred.

- [`list_projects`](https://aimpreviz.com/developers/reference/list_projects)
- [`get_board`](https://aimpreviz.com/developers/reference/get_board)
- [`board_query`](https://aimpreviz.com/developers/reference/board_query)
- [`scene_graph`](https://aimpreviz.com/developers/reference/scene_graph)
- [`list_identities`](https://aimpreviz.com/developers/reference/list_identities)
- [`provenance_report`](https://aimpreviz.com/developers/reference/provenance_report)
- [`read_drift`](https://aimpreviz.com/developers/reference/read_drift)
- [`plan_quote`](https://aimpreviz.com/developers/reference/plan_quote)
- [`list_footage`](https://aimpreviz.com/developers/reference/list_footage)
- [`list_looks`](https://aimpreviz.com/developers/reference/list_looks)
- [`get_shot_sheet`](https://aimpreviz.com/developers/reference/get_shot_sheet)
- [`list_meshes`](https://aimpreviz.com/developers/reference/list_meshes)
- [`get_account`](https://aimpreviz.com/developers/reference/get_account)
- [`get_engine_policy`](https://aimpreviz.com/developers/reference/get_engine_policy)
- [`explain_route`](https://aimpreviz.com/developers/reference/explain_route)
- [`list_voices`](https://aimpreviz.com/developers/reference/list_voices)
- [`get_cast`](https://aimpreviz.com/developers/reference/get_cast)
- [`brain_search`](https://aimpreviz.com/developers/reference/brain_search)
- [`brain_context`](https://aimpreviz.com/developers/reference/brain_context)
- [`ask_brain`](https://aimpreviz.com/developers/reference/ask_brain)
- [`list_decisions`](https://aimpreviz.com/developers/reference/list_decisions)
- [`get_entity`](https://aimpreviz.com/developers/reference/get_entity)
- [`stale_since`](https://aimpreviz.com/developers/reference/stale_since)
- [`check_continuity`](https://aimpreviz.com/developers/reference/check_continuity)
- [`plan_chain`](https://aimpreviz.com/developers/reference/plan_chain)
- [`get_script`](https://aimpreviz.com/developers/reference/get_script)
- [`list_scenes`](https://aimpreviz.com/developers/reference/list_scenes)
- [`get_scene`](https://aimpreviz.com/developers/reference/get_scene)
- [`list_locks`](https://aimpreviz.com/developers/reference/list_locks)
- [`list_revisions`](https://aimpreviz.com/developers/reference/list_revisions)
- [`list_templates`](https://aimpreviz.com/developers/reference/list_templates)
- [`list_capabilities`](https://aimpreviz.com/developers/reference/list_capabilities)
- [`simulate_policy`](https://aimpreviz.com/developers/reference/simulate_policy)

### Shoot

Frames, edits, takes, frame surgery and meshes, through the same gated, metered functions the studio's own buttons run. A paid one called without a quoteToken or an idempotencyKey answers with its quote and runs nothing.

- [`generate_frame`](https://aimpreviz.com/developers/reference/generate_frame)(quoted)
- [`edit_frame`](https://aimpreviz.com/developers/reference/edit_frame)(quoted)
- [`animate_frame`](https://aimpreviz.com/developers/reference/animate_frame)(quoted)
- [`check_take`](https://aimpreviz.com/developers/reference/check_take)
- [`estimate_depth`](https://aimpreviz.com/developers/reference/estimate_depth)(quoted)
- [`decompose_frame`](https://aimpreviz.com/developers/reference/decompose_frame)(quoted)
- [`inpaint_frame`](https://aimpreviz.com/developers/reference/inpaint_frame)(quoted)
- [`relight_frame`](https://aimpreviz.com/developers/reference/relight_frame)(quoted)
- [`split_plate`](https://aimpreviz.com/developers/reference/split_plate)(quoted)
- [`generate_mesh`](https://aimpreviz.com/developers/reference/generate_mesh)(quoted)
- [`check_mesh`](https://aimpreviz.com/developers/reference/check_mesh)
- [`start_production`](https://aimpreviz.com/developers/reference/start_production)
- [`say`](https://aimpreviz.com/developers/reference/say)
- [`answer`](https://aimpreviz.com/developers/reference/answer)
- [`decide`](https://aimpreviz.com/developers/reference/decide)
- [`stop`](https://aimpreviz.com/developers/reference/stop)
- [`resume`](https://aimpreviz.com/developers/reference/resume)
- [`get_production`](https://aimpreviz.com/developers/reference/get_production)
- [`list_productions`](https://aimpreviz.com/developers/reference/list_productions)
- [`production_settings`](https://aimpreviz.com/developers/reference/production_settings)
- [`queue_edit`](https://aimpreviz.com/developers/reference/queue_edit)
- [`get_take_frame`](https://aimpreviz.com/developers/reference/get_take_frame)
- [`convert_voice`](https://aimpreviz.com/developers/reference/convert_voice)(quoted)
- [`speak_line`](https://aimpreviz.com/developers/reference/speak_line)(quoted)
- [`get_take_audio`](https://aimpreviz.com/developers/reference/get_take_audio)
- [`separate_audio`](https://aimpreviz.com/developers/reference/separate_audio)(quoted)
- [`generate_sfx`](https://aimpreviz.com/developers/reference/generate_sfx)(quoted)
- [`generate_music`](https://aimpreviz.com/developers/reference/generate_music)(quoted)
- [`replay_stale`](https://aimpreviz.com/developers/reference/replay_stale)(quoted)
- [`replay_job`](https://aimpreviz.com/developers/reference/replay_job)
- [`run_chain`](https://aimpreviz.com/developers/reference/run_chain)(quoted)
- [`resume_chain`](https://aimpreviz.com/developers/reference/resume_chain)
- [`run_template`](https://aimpreviz.com/developers/reference/run_template)

### Board

Place results on an Infinitum board, lock an identity, pin a note. Free writes to your own projects.

- [`place_on_board`](https://aimpreviz.com/developers/reference/place_on_board)
- [`lock_identity`](https://aimpreviz.com/developers/reference/lock_identity)
- [`write_note`](https://aimpreviz.com/developers/reference/write_note)
- [`cast_voice`](https://aimpreviz.com/developers/reference/cast_voice)
- [`propose_decision`](https://aimpreviz.com/developers/reference/propose_decision)
- [`propose_script_revision`](https://aimpreviz.com/developers/reference/propose_script_revision)

### Cut

Read a Sequence Lane as a conform manifest and render the cut.

- [`get_cut`](https://aimpreviz.com/developers/reference/get_cut)
- [`render_cut`](https://aimpreviz.com/developers/reference/render_cut)(quoted)
- [`check_cut_continuity`](https://aimpreviz.com/developers/reference/check_cut_continuity)
- [`judge_cut_continuity`](https://aimpreviz.com/developers/reference/judge_cut_continuity)(quoted)

### Host

Upload an asset and read the events cursor, for panels, scripts and pipelines.

- [`upload_asset`](https://aimpreviz.com/developers/reference/upload_asset)
- [`events_since`](https://aimpreviz.com/developers/reference/events_since)
- [`get_job`](https://aimpreviz.com/developers/reference/get_job)
- [`list_jobs`](https://aimpreviz.com/developers/reference/list_jobs)
- [`get_audit_log`](https://aimpreviz.com/developers/reference/get_audit_log)
- [`freeze`](https://aimpreviz.com/developers/reference/freeze)
- [`list_mandates`](https://aimpreviz.com/developers/reference/list_mandates)
- [`get_mandate`](https://aimpreviz.com/developers/reference/get_mandate)
- [`request_mandate`](https://aimpreviz.com/developers/reference/request_mandate)
- [`await_approval`](https://aimpreviz.com/developers/reference/await_approval)
- [`cancel_job`](https://aimpreviz.com/developers/reference/cancel_job)
- [`subscribe_webhook`](https://aimpreviz.com/developers/reference/subscribe_webhook)
- [`list_webhooks`](https://aimpreviz.com/developers/reference/list_webhooks)
- [`rotate_webhook_secret`](https://aimpreviz.com/developers/reference/rotate_webhook_secret)
- [`test_webhook`](https://aimpreviz.com/developers/reference/test_webhook)
- [`delete_webhook`](https://aimpreviz.com/developers/reference/delete_webhook)
- [`simulate_event`](https://aimpreviz.com/developers/reference/simulate_event)
- [`get_governance`](https://aimpreviz.com/developers/reference/get_governance)
- [`get_set_package`](https://aimpreviz.com/developers/reference/get_set_package)
- [`send_engine_frame`](https://aimpreviz.com/developers/reference/send_engine_frame)
- [`report_set_build`](https://aimpreviz.com/developers/reference/report_set_build)
- [`get_set_link_status`](https://aimpreviz.com/developers/reference/get_set_link_status)

### Live

Read a live session's direction log, direct a set that is on air, play a board live.

- [`get_take_log`](https://aimpreviz.com/developers/reference/get_take_log)
- [`list_live_sessions`](https://aimpreviz.com/developers/reference/list_live_sessions)
- [`live_direct`](https://aimpreviz.com/developers/reference/live_direct)
- [`play_board`](https://aimpreviz.com/developers/reference/play_board)

[The whole reference on one page, with every error the door returns](https://aimpreviz.com/developers/reference)

## Not built yet

Said plainly so nobody builds against something that is not there. Each moves into the pages above when it ships, and not before.

- A PREVIZ REST mapping of the same operations is not built yet; every call is JSON-RPC to the MCP server.
- Webhook delivery is not built yet; poll the events_since tool for finished takes, meshes and drift warnings.
- A PREVIZ client package of its own is not built yet; any MCP client, or plain HTTPS, works today.
- Cancelling a running job is not built yet; get_job waits for and reads a job, and its receipt says what it charged.
- Sign-in from clients that take only an address (Claude.ai's connector, ChatGPT) is not open yet; use a client that can send a header.

[Mint a key](https://aimpreviz.com/account) [Claude Code recipe](https://aimpreviz.com/developers/connect/claude-code) [Tool reference](https://aimpreviz.com/developers/reference) [Why an agent door](https://aimpreviz.com/learn/agents-for-creative-tools)
