TARKOVSKY FIELD GUIDEOpen studio →

FIELD GUIDE · API FOR AGENTS

The Tarkovsky Studio API,
for agents.

For agents, assistants and the people who build them: how to connect, the rules every call follows, the 26 tools and the 409 studio routes open to an agent, each with what it costs.

Three ways in

An agent or assistant you connect works for you in your account. It does what the studio's own pages do, with the same checks and prices, one request at a time. There are three ways to call it, all behind the same key or sign-in.

The three ways in
Way inAddressFor
MCPhttps://tarkovsky.ai/mcpAssistants and agents that speak the Model Context Protocol (Streamable HTTP, JSON-RPC). They get the 26 tools below.
The tools over RESThttps://tarkovsky.ai/agent/v1/tools/<name>The same tools, one POST each, for a script or a backend.
The studio's routes (the door)https://tarkovsky.ai/agent/v1/api/<path> and https://tarkovsky.ai/agent/v1/media/{id}Every route the studio's page uses that is open to an agent: 409 of them, below. Files (a still, a take, a render) come from /agent/v1/media/{id}. An assistant with no shell calls them with the studio_request tool.
Machine-readable descriptions
WhatAddress
This document, as Markdownhttps://tarkovsky.ai/help/api.md
OpenAPI 3.1 (the tools and every route at the door)https://tarkovsky.ai/agent/v1/openapi.json
The routes at the door, in shorthttps://tarkovsky.ai/agent/v1/api.md
The MCP server cardhttps://tarkovsky.ai/.well-known/mcp/server-card.json
Who signs tokens in (RFC 9728)https://tarkovsky.ai/.well-known/oauth-protected-resource
The site, for language modelshttps://tarkovsky.ai/llms.txt

Connecting

With an agent key

  • Signed in to the studio, POST /api/account/agent-links with {"name": "My agent", "budgetCredits": 50} makes a key. The answer shows the key (tk_…) once: keep it. An account keeps at most 20 keys.
  • Send it on every call as Authorization: Bearer tk_….
  • GET /api/account/agent-links lists your connections, what each has spent and which way each called in the last 30 days. PUT /api/account/agent-links/{id} changes a name or a budget; DELETE /api/account/agent-links/{id} revokes one at once. These are yours, in the studio: an agent can't call them.
  • A key may carry the scopes below; without any it has projects:read, projects:write, spend.
claude mcp add --transport http tarkovsky https://tarkovsky.ai/mcp --header "Authorization: Bearer tk_…"

With a sign-in (OAuth)

An MCP client that supports OAuth 2.1 with PKCE learns where to sign you in from https://tarkovsky.ai/.well-known/oauth-protected-resource, signs you in at the studio's sign-in page and asks for these scopes:

The scopes
ScopeWhat it allows
projects:readRead the filmmaker's projects, their media and the catalogs.
projects:writeChange them as the studio's pages do: saves, locks, plans, choices.
spendHold credits for a paid call, within the connection's budget.

Each connection, a key or a sign-in, has its own budget in credits: 200 unless you set another.

The rules every call follows

  • It runs as the filmmaker. Every request has the studio page's own checks, prices and guards. A refusal says why, as { "error": "…", "status": 403 }.
  • The terms come first. Until the account holder accepts the current Terms of Service and Privacy Notice in the studio, generations, purchases and agent calls are refused (403).
  • Money. A route or tool is free (changes nothing that costs), a quote (free; nothing held) or paid. A paid call needs the spend scope (403 without it). Its credits are held before it runs and settled when it lands. A call whose most would pass the connection's budget is refused with 402, and nothing is held. Credits are bought in the studio, never through an agent.
  • Saves carry a revision. Read a project (GET /agent/v1/api/projects/{id}) for its revision and send it with a save. A save from an older revision is refused with 409 ("Another session changed this project. Reload before saving."); read again and reapply. A locked draft refuses changes to its script (409) until a new draft is opened.
  • Retries are safe with an Idempotency-Key. A write with an Idempotency-Key header (at most 120 characters) answers a retry with its first JSON answer and the header Idempotent-Replayed: true, instead of running again.
  • Nothing is deleted. Every DELETE at the door is refused; deleting is the filmmaker's, in the studio. So are buying credits, sharing, publishing to the Gallery, confirming the rights to a picture and answering a flag (the full list is below).
  • Limits. 120 calls a minute on a token; past it, 429 with RateLimit headers, then try again.
  • The caller's cookies never pass, and no cookie comes back. Bodies are JSON as the page sends them; an upload's bytes pass as they are.
The answers you can get
StatusMeans
200, 201Done. The studio's answer, as its page gets it.
400The body isn't what the route takes. The error names the field.
401No key or token, or a revoked or expired one.
402Past the connection's budget. Nothing was held.
403Refused: the filmmaker's own, a missing scope, the terms not yet accepted, or the studio's own rule. The error says which.
404No such project, file or route. A route the door doesn't know names this page.
409A stale revision, a locked draft, or an Idempotency-Key still running or used for another request.
429More than 120 calls a minute on the token.
502The studio call didn't complete. Try again (with the same Idempotency-Key).
503The studio can't reach its AI models right now (studioModelsOut: true). It's on the studio's side and nothing was charged. Try again after Retry-After seconds; the answer isn't kept under an Idempotency-Key.

Examples

With a key in TARKOVSKY_KEY. The projects you can open:

curl -s https://tarkovsky.ai/agent/v1/api/projects \
  -H "Authorization: Bearer $TARKOVSKY_KEY"

Read a project, then save its logline with the revision you read:

curl -s https://tarkovsky.ai/agent/v1/api/projects/$PROJECT -H "Authorization: Bearer $TARKOVSKY_KEY"

curl -s -X PUT https://tarkovsky.ai/agent/v1/api/projects/$PROJECT \
  -H "Authorization: Bearer $TARKOVSKY_KEY" -H "Content-Type: application/json" \
  -H "Idempotency-Key: logline-1" \
  -d '{"revision": 7, "data": {"logline": "Emina waits at the ferry for a man the river may keep."}}'

A tool over REST:

curl -s -X POST https://tarkovsky.ai/agent/v1/tools/get_script \
  -H "Authorization: Bearer $TARKOVSKY_KEY" -H "Content-Type: application/json" \
  -d '{"projectId": "'$PROJECT'"}'

Any studio route from an MCP client, through studio_request:

curl -s -X POST https://tarkovsky.ai/mcp \
  -H "Authorization: Bearer $TARKOVSKY_KEY" -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -d '{"jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": {"name": "studio_request", "arguments": {"method": "GET", "path": "/api/projects"}}}'

The tools (26)

The same tools over MCP and REST. In MCP each carries its annotations (read-only, destructive, idempotent); in REST its input is the JSON body. 4 are paid.

list_projects: List the filmmaker's projects

Use this first, when you need a project's id or want to know what the filmmaker has in Tarkovsky. Returns each project's id, title, kind, logline, when it last changed, the filmmaker's role on it, and whether it is their copy of the sample film. Archived projects are left out unless asked for. Changes nothing.

Free. It only reads. REST: POST /agent/v1/tools/list_projects with the inputs as a JSON body. MCP: tools/call with name: "list_projects".

list_projects's inputs
InputTypeRequiredWhat it is
includeArchivedbooleannoInclude archived projects.

get_project: Read a project's state

Use this to see where a project stands before planning work: title, logline, whether the script is locked, whether the kickoff is answered, whether paid steps wait for it (kickoffRequired: it is marked required, or a Tarkovsky Director run is on), the project's video model (none chosen: takes use the studio's default), how many scenes, shots, stills and takes exist and how many are loved, the cuts, the project's budget and spend, and the link that opens it in the studio. Changes nothing.

Free. It only reads. REST: POST /agent/v1/tools/get_project with the inputs as a JSON body. MCP: tools/call with name: "get_project".

get_project's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).

get_script: Read the script

Use this to read a project's screenplay: the locked script when there is one (production works from it), else the working draft, with the scenes (id, heading, who and what is tagged in each). Use the scene ids with get_shots. Changes nothing.

Free. It only reads. REST: POST /agent/v1/tools/get_script with the inputs as a JSON body. MCP: tools/call with name: "get_script".

get_script's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).

get_shots: Read the shot list

Use this to see the planned shots of a project or one scene: each shot's label, size, move, duration, description and dialogue, its keyframes (first, key, last; which still is loved), its parts, and sidesChange when someone crosses in it (its people may then change sides of the frame between its keyframes). Use the shot and keyframe ids with make_still and make_take. Changes nothing.

Free. It only reads. REST: POST /agent/v1/tools/get_shots with the inputs as a JSON body. MCP: tools/call with name: "get_shots".

get_shots's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
sceneIdstring (uuid)noOne scene's shots only.

get_storyboard: Read the storyboard

Use this to see the stills made for each keyframe (media ids and which is loved) and the places' plates, so you know what exists before making more. Media opens in the studio for the signed-in filmmaker. Changes nothing.

Free. It only reads. REST: POST /agent/v1/tools/get_storyboard with the inputs as a JSON body. MCP: tools/call with name: "get_storyboard".

get_storyboard's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
sceneIdstring (uuid)noOne scene only.

get_takes: Read the takes

Use this to see the video takes made for the shots (or one shot): name, part, the video model, the media id, and whether it is loved (a loved take is the one the cut uses). Changes nothing.

Free. It only reads. REST: POST /agent/v1/tools/get_takes with the inputs as a JSON body. MCP: tools/call with name: "get_takes".

get_takes's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
shotIdstring (uuid)noOne shot's takes only.

get_cuts: Read the cuts and renders

Use this to see the edit's versions (sequences; which is current) and the finished renders of the film, with their labels and sizes, before rendering again. Changes nothing.

Free. It only reads. REST: POST /agent/v1/tools/get_cuts with the inputs as a JSON body. MCP: tools/call with name: "get_cuts".

get_cuts's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).

get_credits: Read credits and limits

Use this before paid work and whenever the filmmaker asks what something cost: the wallet's balance and plan, this link's budget, what it has spent or holds and what is left, and, with a project id, that project's own budget and spend, and the page with the plans and credit prices (pricing). Credits are bought on the filmmaker's site, never here. Changes nothing.

Free. It only reads. REST: POST /agent/v1/tools/get_credits with the inputs as a JSON body. MCP: tools/call with name: "get_credits".

get_credits's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)noAlso the project's budget and spend.

get_jobs: Read jobs

Use this to see the state of stills, takes and renders in progress or landed (queued, running, succeeded, failed; the media id when landed; the error when not). Give job ids to read only those. Changes nothing.

Free. It only reads. REST: POST /agent/v1/tools/get_jobs with the inputs as a JSON body. MCP: tools/call with name: "get_jobs".

get_jobs's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
jobIdsstring (uuid)[] (at most 50)noOnly these jobs.

wait_for_jobs: Wait for jobs to land

Use this after make_still, make_take or render to wait for the jobs to land, up to 55 seconds a call (call it again if some are still running). Reports progress while it waits and answers which jobs landed and how. Spends nothing.

Free. It only reads. REST: POST /agent/v1/tools/wait_for_jobs with the inputs as a JSON body. MCP: tools/call with name: "wait_for_jobs".

wait_for_jobs's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
jobIdsstring (uuid)[] (at most 50)yesThe jobs to wait for.
secondsinteger (5–55)noHow long to wait at most (default 30).

make_still: Make a still

Use this when a shot needs a picture: it makes the stills of a shot's keyframes that have none loved (or one keyframe again, with a note). The studio builds the prompt and references from the plan; you write no prompt. Costs credits: before it runs the studio holds up to the quoted ceiling (the answer gives ceilingCredits, the most it can cost, and heldCredits, what the studio held), charges the real cost when it lands, and nothing for an unusable answer. Refused, with nothing held, past this link's budget, the project's budget or the remake limit, or before the kickoff is answered when it is required (get_project's kickoffRequired). Returns at once with job ids: use wait_for_jobs.

Paid: credits are held first, within the connection's budget, with the spend scope. REST: POST /agent/v1/tools/make_still with the inputs as a JSON body. MCP: tools/call with name: "make_still".

make_still's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
shotIdstring (uuid)yesThe shot (from get_shots).
keyframeIdstring (uuid)noOne keyframe to make again (else every keyframe of the shot with no loved still).
notestring (0–500 chars)noWhat to change, for a keyframe made again.
remakebooleannoMake every keyframe of the shot again, loved ones too.
titleInPicturebooleannotrue: draw the title the shot's words ask for (exemplified by, but not limited to, a TITLE: or SUPER: line, or a title in quotation marks) in the shot's stills and takes, as the filmmaker's “Put it in the picture anyway” does. Leave it out, and the shot keeps the filmmaker's choice; with none, the title stays out of the picture. Refused, with nothing held, when the shot's words ask for no title or the filmmaker chose “Add it in Edit”.

make_take: Make a take

Use this when a shot has its stills loved and needs its video take: it makes the takes of the shot's parts that have none loved (or one part again, with a note), on the project's video model unless another is named. The board must be locked and the frames loved. Costs credits as make_still does (held up to the ceiling, settled on landing, nothing for an unusable answer); refused with nothing held past the budgets, or before a required kickoff is answered. Returns at once with job ids.

Paid: credits are held first, within the connection's budget, with the spend scope. REST: POST /agent/v1/tools/make_take with the inputs as a JSON body. MCP: tools/call with name: "make_take".

make_take's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
shotIdstring (uuid)yesThe shot (from get_shots).
partinteger (1–20)noOne part of the shot to make again (1-based).
notestring (0–500 chars)noA direction for the retake.
modelstring (0–200 chars)noA video model id from the studio's catalog (else the project's).
frames"first" | "both"noSend the first frame only, or first and last.
titleInPicturebooleannotrue: draw the title the shot's words ask for (exemplified by, but not limited to, a TITLE: or SUPER: line, or a title in quotation marks) in the shot's stills and takes, as the filmmaker's “Put it in the picture anyway” does. Leave it out, and the shot keeps the filmmaker's choice; with none, the title stays out of the picture. Refused, with nothing held, when the shot's words ask for no title or the filmmaker chose “Add it in Edit”.

render: Render the cut

Use this when the cut is ready to watch: it renders the current version of the edit (or a named version or one scene) to a screening copy. Renders spend no credits but take minutes and count toward the account's render queue. Returns at once with a job id; the file is listed by get_cuts when it lands and opens in the studio.

Free. It changes the project. REST: POST /agent/v1/tools/render with the inputs as a JSON body. MCP: tools/call with name: "render".

render's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
sequenceIdstring (uuid)noA version of the edit (from get_cuts); else the current one.
sceneIdstring (uuid)noRender one scene of the cut.

get_take_sheet: Look at a take

Use this before set_cuts, to see what is in a take: its contact sheets (frames from the whole take, about two a second, each with its time in seconds in its top-left corner), the planned lines, where someone speaks in it, and, once it is transcribed, every word said with its time, and the rule a cut in it keeps. The sheets come as pictures after the answer. Use it to choose the loved takes and where to cut them. Free; changes nothing.

Free. It only reads. REST: POST /agent/v1/tools/get_take_sheet with the inputs as a JSON body. MCP: tools/call with name: "get_take_sheet".

get_take_sheet's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
takeIdstring (uuid)yesThe take (from get_takes).
imagesbooleannoSend the contact sheets as pictures (default true); false answers the times, speech and words alone.

set_cuts: Write the cut

Use this to edit the film from its loved takes: it writes the cut of one scene (sceneId: the scene's clips are replaced where it sits in the edit) or of the whole film (no sceneId), the cuts in the order they play, each a loved take with its in and out point in seconds inside the take. It is checked first, as the studio's Rough Cut is: loved takes only; on a shot with lines no cut inside speech (between two words is fine once the take has its words: get_take_sheet); the parts of a shot that play one after the other join untrimmed. A refused cut changes nothing and says why. The cut is a new version of the edit, made from the current one and made current (the version before stays as it was); pass the sequenceId it answers to write into it again. The loved takes it doesn't use wait on V2, switched off. It is one line in Edit's History, which the filmmaker can undo. Free: no model, no credits. Then render it.

Free. It changes the project. REST: POST /agent/v1/tools/set_cuts with the inputs as a JSON body. MCP: tools/call with name: "set_cuts".

set_cuts's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
sceneIdstring (uuid)noOne scene's cut (the scene ids are in get_script and get_shots); leave it out for the whole film.
cutsobject[] (at most 400)yesThe cuts, in the order they play: each a loved take's takeId, its in and out points in seconds inside the take, and why (optional).
notestring (0–1000 chars)noWhat this cut is for, in the filmmaker's words (shown in Edit's History).
sequenceIdstring (uuid)noThe version of the edit to write into, which must be the current one (get_cuts), such as the one the last set_cuts made. Leave it out to make a new version.

create_project: Create a project

Use this when the filmmaker wants a new film in Tarkovsky: it creates the project (a film, a commercial or a single shot) with its title and logline, and saves the script if the filmmaker has one. Without a script, start_run writes it from their story. Counts toward the plan's projects; spends no credits.

Free. It changes the project. REST: POST /agent/v1/tools/create_project with the inputs as a JSON body. MCP: tools/call with name: "create_project".

create_project's inputs
InputTypeRequiredWhat it is
titlestring (1–200 chars)yesThe project's title.
type"Film" | "Commercial" | "Single shot"noFilm unless the filmmaker says otherwise.
loglinestring (0–2000 chars)noOne or two sentences: what the film is.
ratio"16:9" | "21:9" | "2.39:1" | "9:16" | "1:1"noThe frame: 16:9 unless the filmmaker says otherwise.
scriptstring (0–200000 chars)noThe filmmaker's screenplay, as they wrote it (scene headings, action, dialogue). Leave it out to have the script written from their story.

estimate_film: Estimate the film

Use this before start_run when the filmmaker wants to know what making the film with Tarkovsky Director will cost: the whole-film estimate in credits, stage by stage, from where the project stands. Free; changes nothing.

Free. It only reads. REST: POST /agent/v1/tools/estimate_film with the inputs as a JSON body. MCP: tools/call with name: "estimate_film".

estimate_film's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
modelstring (0–200 chars)noOne of the Director's models (get_run lists them); else the first offered.

start_run: Start Create With AI

Use this to make the film automatically with Tarkovsky Director, up to a stage the filmmaker chooses (upTo: script, shotlist, stills, takes, roughcut or export), so they can review and correct it there before the next stage (resume_run). When the kickoff isn't answered yet, it is answered for them with every area handed to the Director, the stage, and their story and the film's length if given. Costs credits: the run's whole budget counts on this connection while it runs, and the run never spends past it; refused, with nothing started, past this connection's budget, the wallet or the project's budget. Returns at once; follow it with get_run.

Paid: credits are held first, within the connection's budget, with the spend scope. REST: POST /agent/v1/tools/start_run with the inputs as a JSON body. MCP: tools/call with name: "start_run".

start_run's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
budgetCreditsinteger (1–1000000)yesThe most the run may spend, in credits. At least about three of the Director's turns (estimate_film): a smaller run is refused.
upTo"script" | "shotlist" | "stills" | "takes" | "roughcut" | "export"yesWhere the run stops for the filmmaker's review.
storystring (0–40000 chars)noWhat the film is about, in the filmmaker's words (notes, or a synopsis), when there is no script yet.
filmMinutesinteger (1–180)noHow long the film should be, in minutes.
notestring (0–2000 chars)noA direction for this run, in the filmmaker's words.
modelstring (0–200 chars)noOne of the Director's models; else the first offered.

get_run: Follow the run

Use this while Tarkovsky Director works, and when it stops: the run's state (working, stopping, stopped, finished), its step, what it has spent of its budget, the stage it stops at, how it ended (a run that stopped to wait for the filmmaker says what for), what it logged since the line you last saw (afterLine), what it decided for the filmmaker, which tool goes on (next), and the Director's models. Changes nothing.

Free. It only reads. REST: POST /agent/v1/tools/get_run with the inputs as a JSON body. MCP: tools/call with name: "get_run".

get_run's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
afterLineinteger (0–9007199254740991)noThe last log line you saw (lastLine from the previous answer).

stop_run: Stop the run

Use this when the filmmaker wants Tarkovsky Director to stop: no new paid work starts; stills and takes already running land, then the run writes its report. Nothing is lost; resume_run carries on.

Free. It changes the project. REST: POST /agent/v1/tools/stop_run with the inputs as a JSON body. MCP: tools/call with name: "stop_run".

stop_run's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).

resume_run: Run on to the next stage

Use this after the filmmaker has reviewed and corrected a stopped run (stop_run, or the Director stopped to wait for them: get_run's ended says what for): it runs on, up to the next stage they choose (upTo), with more budget and their direction (note). A run that finished at its stage isn't resumed: start_run with the next stage carries the same project on. Costs credits as start_run does: the run's budget counts on this connection while it runs; refused, with nothing started, past this connection's budget.

Paid: credits are held first, within the connection's budget, with the spend scope. REST: POST /agent/v1/tools/resume_run with the inputs as a JSON body. MCP: tools/call with name: "resume_run".

resume_run's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
budgetCreditsinteger (1–1000000)yesMore budget for the run, in credits, on top of what it has spent.
upTo"script" | "shotlist" | "stills" | "takes" | "roughcut" | "export"noWhere the run stops next; else where it stopped before.
notestring (0–2000 chars)noWhat the filmmaker wants changed or kept, in their words.

love_still: Love a still

Use this when the filmmaker chooses which still a keyframe uses (a loved still is the frame takes are made from, and the reference for the shots after it). A still whose check found a must-fix problem, or that has no check yet, is refused: the filmmaker decides that one in the studio, or you remake it with a note (make_still). Spends no credits.

Free. It changes the project. REST: POST /agent/v1/tools/love_still with the inputs as a JSON body. MCP: tools/call with name: "love_still".

love_still's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
shotIdstring (uuid)yesThe shot (from get_shots).
keyframeIdstring (uuid)yesThe keyframe (from get_shots).
mediaIdstring (uuid)yesThe still to love (from get_storyboard).

love_take: Love a take

Use this when the filmmaker chooses which take a shot uses (the cut uses loved takes). A take with a must-fix finding, or with a cut or dissolve inside it, is refused: the filmmaker decides that one in the studio, or you remake it with a note (make_take). Spends no credits.

Free. It changes the project. REST: POST /agent/v1/tools/love_take with the inputs as a JSON body. MCP: tools/call with name: "love_take".

love_take's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).
takeIdstring (uuid)yesThe take to love (from get_takes).

lock_script: Lock the script

Use this when the filmmaker approves the script: locking makes it the production script (scenes, people and places tagged), which shots are planned from. Free. A locked script changes only in the studio.

Free. It changes the project. REST: POST /agent/v1/tools/lock_script with the inputs as a JSON body. MCP: tools/call with name: "lock_script".

lock_script's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).

lock_board: Lock the board

Use this when the filmmaker approves the storyboard: takes are made only for the shots on the locked board. Free. Unlock it in the studio to change the board.

Free. It changes the project. REST: POST /agent/v1/tools/lock_board with the inputs as a JSON body. MCP: tools/call with name: "lock_board".

lock_board's inputs
InputTypeRequiredWhat it is
projectIdstring (uuid)yesThe project's id (from list_projects).

studio_request: Make one studio request

Use this for anything in the studio no other tool here does: one request to the studio's own API as the filmmaker, with the same checks, prices and guards as the page. Paths start with /api/ (every route open to you is in the API reference, https://tarkovsky.ai/agent/v1/openapi.json, with what it costs) or are /media/<id> for a file. GET reads; POST, PUT and PATCH change the project; a paid route holds credits within this connection's budget, and a refusal says why in plain words. Nothing is deleted from here. Stills and takes go through make_still and make_take, which build their prompts; the Director through start_run. Answers are {status, body}; a long one is cut to maxChars, and pick keeps only the fields you name.

Free. It only reads. REST: POST /agent/v1/tools/studio_request with the inputs as a JSON body. MCP: tools/call with name: "studio_request".

studio_request's inputs
InputTypeRequiredWhat it is
method"GET" | "POST" | "PUT" | "PATCH"yesGET reads; POST, PUT and PATCH change.
pathstring (5–500 chars)yesThe route with its query string, as in the API reference without /agent/v1, e.g. /api/projects/<id>/kickoff.
bodyobjectnoThe JSON body (POST, PUT, PATCH).
pickstring (0–200 chars)[] (at most 40)noDotted paths to keep, e.g. ['revision','data.shots[].id']; '[]' maps over an array.
maxCharsinteger (200–40000)noCut the answer to this many characters (default 4000).

The studio's routes at the door (409)

Each is the studio's own /api/… route, called at https://tarkovsky.ai/agent/v1/api/… (the paths below), as the page calls it. Bodies are the page's JSON. Read the route's answer for its shape. The OpenAPI document lists the same routes with their money class.

studio: The studio's own routes: the session, projects, saving, media, jobs and the model catalogs.

The routes in studio
MethodPathMoneyOnly
GET/agent/v1/api/assistant/settingsfree
GET/agent/v1/api/images/modelsfree
POST/agent/v1/api/images/quotequote (free; nothing held)
GET/agent/v1/api/managed/modelsfree
GET/agent/v1/api/models/defaultsfree
GET/agent/v1/api/projectsfree
GET/agent/v1/api/projects/{id}free
PATCH/agent/v1/api/projects/{id}freethe save as what it changed (0.68.5), by the PUT's rules: without kickoff in its patch (the kickoff is the filmmaker's)
PUT/agent/v1/api/projects/{id}freethe save, without kickoff in its data (the kickoff is the filmmaker's)
GET/agent/v1/api/projects/{id}/accessfree
POST/agent/v1/api/projects/{id}/chatpaid (credits held first)
POST/agent/v1/api/projects/{id}/draftsfree
GET/agent/v1/api/projects/{id}/export/{format}free
POST/agent/v1/api/projects/{id}/freshfreea read: what changed since the caller's own copy (0.68.5)
GET/agent/v1/api/projects/{id}/jobsfree
POST/agent/v1/api/projects/{id}/jobspaid (credits held first)kind render here; a still or a take through make_still or make_take, which build its prompt as the page does
POST/agent/v1/api/projects/{id}/lockfree
POST/agent/v1/api/projects/{id}/managed/chatpaid (credits held first)
POST/agent/v1/api/projects/{id}/managed/quotequote (free; nothing held)
GET/agent/v1/api/projects/{id}/mediafree
POST/agent/v1/api/projects/{id}/mediafree
GET/agent/v1/api/projects/{id}/revisionfree
GET/agent/v1/api/sessionfree
GET/agent/v1/api/video/modelsfree
POST/agent/v1/api/video/quotequote (free; nothing held)
POST/agent/v1/api/voice/quotequote (free; nothing held)
GET/agent/v1/api/voice/servicesfree
GET/agent/v1/api/voicesfree
GET/agent/v1/media/{id}free

billing

The routes in billing
MethodPathMoneyOnly
GET/agent/v1/api/billingfree
GET/agent/v1/api/billing/usagefree

agent-runs

The routes in agent-runs
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/agent/runsfree
GET/agent/v1/api/projects/{id}/agent/runs/{run}free
POST/agent/v1/api/projects/{id}/agent/runs/{run}/deadlinefree
POST/agent/v1/api/projects/{id}/agent/runs/{run}/decisionsfree
GET/agent/v1/api/projects/{id}/agent/runs/{run}/flagsfree
POST/agent/v1/api/projects/{id}/agent/runs/{run}/problemsfree
PATCH/agent/v1/api/projects/{id}/agent/runs/{run}/problems/{problem}free
GET/agent/v1/api/projects/{id}/agent/runs/{run}/reportfree
POST/agent/v1/api/projects/{id}/agent/runs/{run}/story-draftfree
POST/agent/v1/api/projects/{id}/agent/runs/{run}/story-flagfree

ask-takes: a new take's own changes, kept for it (free)

The routes in ask-takes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/ask-takesfree
POST/agent/v1/api/projects/{id}/ask-takesfreea shot's next take's own changes, checked against the shot; never the project's stored data
POST/agent/v1/api/projects/{id}/ask-takes/{rowId}/madefreethe project's own jobs only

angle-set-routes: POST /:assetId/angles/quote (free), POST /:assetId/angles (paid), GET /:assetId/angles

The routes in angle-set-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/assets/{assetId}/anglesfree
POST/agent/v1/api/projects/{id}/assets/{assetId}/anglespaid (credits held first)
POST/agent/v1/api/projects/{id}/assets/{assetId}/angles/quotequote (free; nothing held)

description-impact-routes: POST /:assetId/description, /description-offers/:offerId (free)

The routes in description-impact-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/assets/{assetId}/descriptionfree
POST/agent/v1/api/projects/{id}/assets/description-offers/{offerId}free

description-remake-routes: POST /:assetId/description/remake/quote (free), /:assetId/description/remake (paid)

The routes in description-remake-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/assets/{assetId}/description/remakepaid (credits held first)
POST/agent/v1/api/projects/{id}/assets/{assetId}/description/remake/quotequote (free; nothing held)

asset-desk-routes: POST /:assetId/heart, /:assetId/like, GET /:assetId/desk (free); 0.66: POST /:assetId/group (free)

The routes in asset-desk-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/assets/{assetId}/deskfree
POST/agent/v1/api/projects/{id}/assets/{assetId}/groupfree
POST/agent/v1/api/projects/{id}/assets/{assetId}/heartfree
POST/agent/v1/api/projects/{id}/assets/{assetId}/likefree

assets

The routes in assets
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/assets/{assetId}/label-checkpaid (credits held first)
POST/agent/v1/api/projects/{id}/assets/{assetId}/label-check/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/assets/{assetId}/set-pack/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/assets/brand-rules/draftpaid (credits held first)
POST/agent/v1/api/projects/{id}/assets/brand-rules/quotequote (free; nothing held)

marks-check-routes: POST /:assetId/marks-check, a person's check of a profile against the marks and sides line (free)

The routes in marks-check-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/assets/{assetId}/marks-checkfree

sheet-check-routes: POST /assets/:assetId/sheet-check (/quote free), GET /sheet-checks, POST /sheet-checks/:checkId/outcome

The routes in sheet-check-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/assets/{assetId}/sheet-checkpaid (credits held first)
POST/agent/v1/api/projects/{id}/assets/{assetId}/sheet-check/quotequote (free; nothing held)
GET/agent/v1/api/projects/{id}/sheet-checksfree
POST/agent/v1/api/projects/{id}/sheet-checks/{checkId}/outcomefree

heart-change-routes: made-from, preview, compare, apply, remake, likes, remakes, flags

The routes in heart-change-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/assets/hearts/applyfree
POST/agent/v1/api/projects/{id}/assets/hearts/comparepaid (credits held first)
GET/agent/v1/api/projects/{id}/assets/hearts/flagsfree
POST/agent/v1/api/projects/{id}/assets/hearts/likesfree
GET/agent/v1/api/projects/{id}/assets/hearts/made-fromfree
POST/agent/v1/api/projects/{id}/assets/hearts/previewfree
POST/agent/v1/api/projects/{id}/assets/hearts/remakepaid (credits held first)
GET/agent/v1/api/projects/{id}/assets/hearts/remakesfree

board-routes: move, duplicate, on/off, delete, insert, undo, redo, jump, lock, the take quote

The routes in board-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/board/deletefree
POST/agent/v1/api/projects/{id}/board/duplicatefree
POST/agent/v1/api/projects/{id}/board/insertfree
POST/agent/v1/api/projects/{id}/board/joinfree
POST/agent/v1/api/projects/{id}/board/jumpfree
POST/agent/v1/api/projects/{id}/board/lockfree
POST/agent/v1/api/projects/{id}/board/movefree
POST/agent/v1/api/projects/{id}/board/offfree
POST/agent/v1/api/projects/{id}/board/placefree
POST/agent/v1/api/projects/{id}/board/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/board/redofree
POST/agent/v1/api/projects/{id}/board/undofree

scene-insert-routes: a new scene for a loose shot of another place (free)

The routes in scene-insert-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/board/scenesfree
POST/agent/v1/api/projects/{id}/board/scenes/askfree

board-version-routes: GET /versions, /versions/:n, POST /versions/:n/start, /versions/:n/rename (free)

The routes in board-version-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/board/versionsfree
GET/agent/v1/api/projects/{id}/board/versions/{n}free
POST/agent/v1/api/projects/{id}/board/versions/{n}/renamefree
POST/agent/v1/api/projects/{id}/board/versions/{n}/startfree

boards: each frame's grey-box board by Blender (farm or this host), free; bring your own (since 0.71.3, TAR-974, its upload takes shows and rights=confirmed as the media upload does)

The routes in boards
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/boardsfree
POST/agent/v1/api/projects/{id}/boardsfree
POST/agent/v1/api/projects/{id}/boards/uploadfree

brainstorm-routes: the thread, the quote, a change within the limit, Keep going, the end

The routes in brainstorm-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/brainstormfree
POST/agent/v1/api/projects/{id}/brainstorm/changepaid (credits held first)
POST/agent/v1/api/projects/{id}/brainstorm/endfree
POST/agent/v1/api/projects/{id}/brainstorm/keep-goingpaid (credits held first)
GET/agent/v1/api/projects/{id}/brainstorm/keptfree
PUT/agent/v1/api/projects/{id}/brainstorm/keptfree
POST/agent/v1/api/projects/{id}/brainstorm/kept/clearfree
POST/agent/v1/api/projects/{id}/brainstorm/quotequote (free; nothing held)

kickoff-brainstorm-routes: Draft it on the kickoff's story, its quote

The routes in kickoff-brainstorm-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/brainstorm/kickoffpaid (credits held first)
POST/agent/v1/api/projects/{id}/brainstorm/kickoff/quotequote (free; nothing held)

brief

The routes in brief
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/brief/draftpaid (credits held first)
POST/agent/v1/api/projects/{id}/brief/importfree
POST/agent/v1/api/projects/{id}/brief/quotequote (free; nothing held)

project-budget: GET the spend against the budget

The routes in project-budget
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/budgetfree

chat

The routes in chat
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/chatfree
POST/agent/v1/api/projects/{id}/chat/messagesfree
PATCH/agent/v1/api/projects/{id}/chat/messages/{mid}free
GET/agent/v1/api/projects/{id}/chat/waits/{wait}free

critic-routes: the instruments, the quote, a pass, the passes, a person's marks

The routes in critic-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/criticfree
POST/agent/v1/api/projects/{id}/criticpaid (credits held first)
POST/agent/v1/api/projects/{id}/critic/instrumentsfree
POST/agent/v1/api/projects/{id}/critic/quotequote (free; nothing held)

part-chain: a later part's chain on a first-frame-only model

The routes in part-chain
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/dailies/chainfree
GET/agent/v1/api/projects/{id}/dailies/chainsfree

dailies-desk-routes: POST /rate, /place, each with its History line (free)

The routes in dailies-desk-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/dailies/notefree
POST/agent/v1/api/projects/{id}/dailies/placefree
POST/agent/v1/api/projects/{id}/dailies/ratefree

picture-change-routes: Change this picture

The routes in picture-change-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/direction/changepaid (credits held first)
POST/agent/v1/api/projects/{id}/direction/change/quotequote (free; nothing held)

direction-routes: propose, pin, check (see direction-routes.ts)

The routes in direction-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/direction/checkpaid (credits held first)
POST/agent/v1/api/projects/{id}/direction/check/quotequote (free; nothing held)
GET/agent/v1/api/projects/{id}/direction/model-notesfree
POST/agent/v1/api/projects/{id}/direction/performance-stillpaid (credits held first)
POST/agent/v1/api/projects/{id}/direction/performance-still/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/direction/pinpaid (credits held first)
POST/agent/v1/api/projects/{id}/direction/pin/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/direction/proposepaid (credits held first)
POST/agent/v1/api/projects/{id}/direction/propose/quotequote (free; nothing held)
GET/agent/v1/api/projects/{id}/direction/spendfree
POST/agent/v1/api/projects/{id}/direction/take-notepaid (credits held first)
POST/agent/v1/api/projects/{id}/direction/take-note/quotequote (free; nothing held)

edit-beds-routes: POST /: the ripple question's choice, with its History line (free)

The routes in edit-beds-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/edit/bedsfree

edit-routes: POST /speech, GET /checks

The routes in edit-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/edit/checksfree
POST/agent/v1/api/projects/{id}/edit/speechfree
GET/agent/v1/api/projects/{id}/edit/wordsfree
POST/agent/v1/api/projects/{id}/edit/wordsfree

edit-titles-routes: POST /titles/line, POST /cutdowns, each with its History line (free)

The routes in edit-titles-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/edit/cutdownsfree
POST/agent/v1/api/projects/{id}/edit/titles/linefree

cut-routes: POST /cuts/quote, POST /cuts: Go to Edit's new cut (free)

The routes in cut-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/edit/cutsfree
POST/agent/v1/api/projects/{id}/edit/cuts/quotequote (free; nothing held)

edit-desk-routes: GET, PUT: the filmmaker's own folds and band height for this project (their settings, free)

The routes in edit-desk-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/edit/deskfree
PUT/agent/v1/api/projects/{id}/edit/deskfree

edit-flag-routes: POST /aside, Not a problem with its History line (free)

The routes in edit-flag-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/edit/flags/asidefree

edit-level-routes: POST /: a level line's change, with its History line (free)

The routes in edit-level-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/edit/levelfree
The routes in voice-link-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/edit/linkfree

edit-remake-routes: POST /remake/plan, POST /remake (free; stills and takes go through /jobs)

The routes in edit-remake-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/edit/remakefree
POST/agent/v1/api/projects/{id}/edit/remake/planfree

rough-cut: POST /rough-cut/quote, POST /rough-cut

The routes in rough-cut
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/edit/rough-cutpaid (credits held first)
POST/agent/v1/api/projects/{id}/edit/rough-cut/quotequote (free; nothing held)

export-desk-routes: limits, renders, compare, checks, set-asides, captions, hand-offs

The routes in export-desk-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/exports/captions.{fmt}free
GET/agent/v1/api/projects/{id}/exports/checksfree
GET/agent/v1/api/projects/{id}/exports/comparefree
GET/agent/v1/api/projects/{id}/exports/contentsfree
GET/agent/v1/api/projects/{id}/exports/handoffsfree
POST/agent/v1/api/projects/{id}/exports/handoffsfree
GET/agent/v1/api/projects/{id}/exports/handoffs/{hid}/downloadfree
GET/agent/v1/api/projects/{id}/exports/limitsfree
GET/agent/v1/api/projects/{id}/exports/rendersfree
GET/agent/v1/api/projects/{id}/exports/set-asidesfree
POST/agent/v1/api/projects/{id}/exports/set-asidesfree

flags-routes: GET the flags, Not a problem, Undo, Generate a take with this fix

The routes in flags-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/flagsfree
POST/agent/v1/api/projects/{id}/flags/{flagId}/dismissfree
POST/agent/v1/api/projects/{id}/flags/{flagId}/fixpaid (credits held first)
POST/agent/v1/api/projects/{id}/flags/{flagId}/fix/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/flags/{flagId}/undofree
POST/agent/v1/api/projects/{id}/flags/olderfree

floor-plan-routes: read, seed, edit, check (free)

The routes in floor-plan-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/floor-plansfree
GET/agent/v1/api/projects/{id}/floor-plans/{sceneId}free
PATCH/agent/v1/api/projects/{id}/floor-plans/{sceneId}free
PUT/agent/v1/api/projects/{id}/floor-plans/{sceneId}free
POST/agent/v1/api/projects/{id}/floor-plans/{sceneId}/checkfree
POST/agent/v1/api/projects/{id}/floor-plans/{sceneId}/seedfree
GET/agent/v1/api/projects/{id}/floor-plans/{sceneId}/shots/{shotId}free
POST/agent/v1/api/projects/{id}/floor-plans/{sceneId}/updatefree

edit-sequences: /sequences…, /frame-rate

The routes in edit-sequences
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/frame-ratefree
GET/agent/v1/api/projects/{id}/sequencesfree
POST/agent/v1/api/projects/{id}/sequencesfree
GET/agent/v1/api/projects/{id}/sequences/{sid}free
PUT/agent/v1/api/projects/{id}/sequences/{sid}free
POST/agent/v1/api/projects/{id}/sequences/{sid}/archivefree
POST/agent/v1/api/projects/{id}/sequences/{sid}/next-cutfree
POST/agent/v1/api/projects/{id}/sequences/{sid}/renamefree
POST/agent/v1/api/projects/{id}/sequences/{sid}/restorefree
POST/agent/v1/api/projects/{id}/sequences/{sid}/send-orderfree
POST/agent/v1/api/projects/{id}/sequences/{sid}/starfree
POST/agent/v1/api/projects/{id}/sequences/assemblyfree
GET/agent/v1/api/projects/{id}/sequences/boardsfree
GET/agent/v1/api/projects/{id}/sequences/ratesfree
POST/agent/v1/api/projects/{id}/sequences/ratesfree
The routes in gallery-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/galleryfree

history-routes: GET ?page=, POST /:entryId/undo, /:entryId/redo

The routes in history-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/historyfree
POST/agent/v1/api/projects/{id}/history/{entryId}/redofree
POST/agent/v1/api/projects/{id}/history/{entryId}/undofree
POST/agent/v1/api/projects/{id}/history/marksfree

kickoff-routes

The routes in kickoff-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/kickofffree
POST/agent/v1/api/projects/{id}/kickofffreethe production choices only (density, protection, the video model and its resolution, the motion check, splits on a locked board, the frame rate); the filmmaker's own answers go through start_run
POST/agent/v1/api/projects/{id}/kickoff/estimatequote (free; nothing held)

commercial-write-routes

The routes in commercial-write-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/kickoff/scriptpaid (credits held first)
POST/agent/v1/api/projects/{id}/kickoff/script/quotequote (free; nothing held)

kickoff-script-auto

The routes in kickoff-script-auto
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/kickoff/script/autofree
POST/agent/v1/api/projects/{id}/kickoff/script/autopaid (credits held first)

place-map-routes: the map's reads, ops, OK and Join at the door (free)

The routes in place-map-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/mapsfree
PATCH/agent/v1/api/projects/{id}/maps/{mapId}free
POST/agent/v1/api/projects/{id}/maps/{mapId}/join-at-doorfree
POST/agent/v1/api/projects/{id}/maps/{mapId}/okfree
POST/agent/v1/api/projects/{id}/maps/{mapId}/ok/undofree

plan-redraw-routes: Redraw from the script (free to the filmmaker)

The routes in plan-redraw-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/maps/redrawfree
POST/agent/v1/api/projects/{id}/maps/redraw/quotequote (free; nothing held)

media-info: anatomy for an administrator // 0.20 (TAR-214): GET /:mediaId/info, /:mediaId/info/sidecar

The routes in media-info
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/media/{mediaId}/infofree
GET/agent/v1/api/projects/{id}/media/{mediaId}/info/sidecarfree

music-routes

The routes in music-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/musicpaid (credits held first)
POST/agent/v1/api/projects/{id}/music/draftpaid (credits held first)
POST/agent/v1/api/projects/{id}/music/draft/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/music/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/music/range/quotequote (free; nothing held)
GET/agent/v1/api/projects/{id}/music/scriptedfree

release-packages: build and download the Release packages; free

The routes in release-packages
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/packagesfree
GET/agent/v1/api/projects/{id}/packages/{pid}free
GET/agent/v1/api/projects/{id}/packages/{pid}/downloadfree

palette-routes: db for the words' model reading · 0.22 (round 10 §10, TAR-265): a palette from a file, a photo or words (free, nothing stored)

The routes in palette-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/palette/brainstormfree
POST/agent/v1/api/projects/{id}/palette/proposefree
GET/agent/v1/api/projects/{id}/palette/suggestfree

waveforms: GET ?media=… the waveforms of sound clips (members, free)

The routes in waveforms
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/peaksfree

upscale-routes: /picture/lock, /picture/unlock, /upscale…

The routes in upscale-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/picture/lockfree
POST/agent/v1/api/projects/{id}/picture/unlockfree
GET/agent/v1/api/projects/{id}/upscalefree
POST/agent/v1/api/projects/{id}/upscalepaid (credits held first)
POST/agent/v1/api/projects/{id}/upscale/{jobId}/undofree
POST/agent/v1/api/projects/{id}/upscale/originalfree

places-routes: the places, their plans and joins (free)

The routes in places-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/placesfree
GET/agent/v1/api/projects/{id}/places/{placeId}free
PATCH/agent/v1/api/projects/{id}/places/{placeId}free
PATCH/agent/v1/api/projects/{id}/places/{placeId}/areas/{areaAssetId}free
POST/agent/v1/api/projects/{id}/places/{placeId}/joinsfree
PATCH/agent/v1/api/projects/{id}/places/{placeId}/joins/{joinId}free

plan-cut-routes: a cut the words ask for, offered as a mark, free

The routes in plan-cut-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/plan-cuts/acceptfree
GET/agent/v1/api/projects/{id}/plan-cuts/offersfree

pre-take

The routes in pre-take
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/pretakepaid (credits held first)
POST/agent/v1/api/projects/{id}/pretake/codefree
POST/agent/v1/api/projects/{id}/pretake/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/pretake/takepaid (credits held first)
POST/agent/v1/api/projects/{id}/pretake/take/quotequote (free; nothing held)

continuity-routes: the shots beside it, a take compared with the take of the shot before it, and its switch (off unless turned on)

The routes in continuity-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/pretake/continuity-criticfree
POST/agent/v1/api/projects/{id}/pretake/continuity-criticpaid (credits held first)
POST/agent/v1/api/projects/{id}/pretake/continuity-critic/quotequote (free; nothing held)

dailies-critic-routes: the Critic on Dailies, a take watched as it lands, and its switch

The routes in dailies-critic-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/pretake/dailies-criticfree
POST/agent/v1/api/projects/{id}/pretake/dailies-criticpaid (credits held first)
POST/agent/v1/api/projects/{id}/pretake/dailies-critic/quotequote (free; nothing held)

dissolve-routes: the dissolve check on every take, the longer take or part 2

The routes in dissolve-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/pretake/dissolvefree
POST/agent/v1/api/projects/{id}/pretake/dissolve/checkpaid (credits held first)
POST/agent/v1/api/projects/{id}/pretake/dissolve/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/pretake/dissolve/retakepaid (credits held first)

take-gate: before Generate a take's hold, free

The routes in take-gate
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/pretake/gatefree

take-match-routes: the take-match check, switched off

The routes in take-match-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/pretake/matchfree
POST/agent/v1/api/projects/{id}/pretake/matchpaid (credits held first)
POST/agent/v1/api/projects/{id}/pretake/match/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/pretake/match/switchpaid (credits held first)

motion-check-routes: quote, run, the latest per take, the automatic setting

The routes in motion-check-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/pretake/motionfree
POST/agent/v1/api/projects/{id}/pretake/motionpaid (credits held first)
POST/agent/v1/api/projects/{id}/pretake/motion/autopaid (credits held first)
POST/agent/v1/api/projects/{id}/pretake/motion/quotequote (free; nothing held)

pretake-notes-routes: Real / Noise, acted / ignored, the rate

The routes in pretake-notes-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/pretake/notesfree
POST/agent/v1/api/projects/{id}/pretake/notes/markfree
POST/agent/v1/api/projects/{id}/pretake/notes/outcomefree
GET/agent/v1/api/projects/{id}/pretake/notes/ratefree

pretake-recheck: only the remade keyframes

The routes in pretake-recheck
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/pretake/recheckpaid (credits held first)
POST/agent/v1/api/projects/{id}/pretake/recheck/quotequote (free; nothing held)

still-check

The routes in still-check
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/pretake/stillfree
POST/agent/v1/api/projects/{id}/pretake/stillpaid (credits held first)
POST/agent/v1/api/projects/{id}/pretake/still/decisionfree
POST/agent/v1/api/projects/{id}/pretake/still/quotequote (free; nothing held)
GET/agent/v1/api/projects/{id}/pretake/still/statesfree

questions-routes: the open questions (Check script, the writer's, Check shot list's notes) and their answers (free)

The routes in questions-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/questionsfree
POST/agent/v1/api/projects/{id}/questions/answerfree

remake-limit-routes: the setting in force, the spend, a verdict

The routes in remake-limit-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/remake-limitsfree
POST/agent/v1/api/projects/{id}/remake-limits/checkfree

renders-routes: GET the finished renders (any member)

The routes in renders-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/rendersfree

render-stop: POST /:jobId/stop, editors, free

The routes in render-stop
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/renders/{jobId}/stopfree

content-research-routes

The routes in content-research-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/research-brieffree

rights: the rights question's switch (off)

The routes in rights
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/rightsfree
GET/agent/v1/api/projects/{id}/rights/logfree
GET/agent/v1/api/rightsfree

screener-routes: list, make (the link once), revoke, views; free

The routes in screener-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/screenersfree
GET/agent/v1/api/projects/{id}/screeners/{sid}/viewsfree

sfx-routes: effects and ambience, quote first, with {kind: "effects" or "ambience", text, start, end} in seconds of the cut, then maxCredits; the sounds the script names

The routes in sfx-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/sfxpaid (credits held first)
POST/agent/v1/api/projects/{id}/sfx/quotequote (free; nothing held)
GET/agent/v1/api/projects/{id}/sfx/scriptedfree
POST/agent/v1/api/projects/{id}/sfx/scripted/findfree

prompt-shorten-routes: Shorten and make's shortening (quote free, the call paid)

The routes in prompt-shorten-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/shortenfree
POST/agent/v1/api/projects/{id}/shortenpaid (credits held first)
POST/agent/v1/api/projects/{id}/shorten/quotequote (free; nothing held)

project-store-routes: History's copies beside the project, the read cache (on), the copies back

The routes in project-store-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/shot-log/copiesfreea read: History lines' copies for their Undo (0.68.5)

scene-notes-routes: GET, PUT: which scenes' notes boxes this person hid on the Shot List (their settings, free)

The routes in scene-notes-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/shotlist/notesfree
PUT/agent/v1/api/projects/{id}/shotlist/notesfree

shot-chat: the Shot List's chat and review

The routes in shot-chat
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/shots/chatpaid (credits held first)
GET/agent/v1/api/projects/{id}/shots/chat/{pending}free
POST/agent/v1/api/projects/{id}/shots/chat/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/shots/checkpaid (credits held first)
POST/agent/v1/api/projects/{id}/shots/check/quotequote (free; nothing held)

sound-only: GET, POST /quote (free), POST (paid), POST /picture (free)

The routes in sound-only
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/sound-onlyfree
POST/agent/v1/api/projects/{id}/sound-onlypaid (credits held first)
POST/agent/v1/api/projects/{id}/sound-only/picturefree
POST/agent/v1/api/projects/{id}/sound-only/quotequote (free; nothing held)

breakdown

The routes in breakdown
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/story/breakdownfree
POST/agent/v1/api/projects/{id}/story/breakdownfree

story

The routes in story
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/story/chatpaid (credits held first)
GET/agent/v1/api/projects/{id}/story/chat/{pending}free
POST/agent/v1/api/projects/{id}/story/checkfree
GET/agent/v1/api/projects/{id}/story/export/{file}free
POST/agent/v1/api/projects/{id}/story/importfree
POST/agent/v1/api/projects/{id}/story/quotequote (free; nothing held)
GET/agent/v1/api/projects/{id}/story/reportfree

script-coverage

The routes in script-coverage
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/story/coveragepaid (credits held first)
GET/agent/v1/api/projects/{id}/story/coverage/{index}.pdffree
POST/agent/v1/api/projects/{id}/story/coverage/quotequote (free; nothing held)

coverage-brainstorm-routes

The routes in coverage-brainstorm-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/story/coverage/brainstormpaid (credits held first)
POST/agent/v1/api/projects/{id}/story/coverage/brainstorm/quotequote (free; nothing held)

storyboard-routes: the paper edit, describe a shot, batch Make, two models

The routes in storyboard-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/storyboardfree
POST/agent/v1/api/projects/{id}/storyboard/batch/planfree
GET/agent/v1/api/projects/{id}/storyboard/comparefree
POST/agent/v1/api/projects/{id}/storyboard/comparefree
POST/agent/v1/api/projects/{id}/storyboard/describe-shotpaid (credits held first)
POST/agent/v1/api/projects/{id}/storyboard/describe-shot/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/storyboard/paper-editfree
POST/agent/v1/api/projects/{id}/storyboard/paper-edit/proposepaid (credits held first)
POST/agent/v1/api/projects/{id}/storyboard/paper-edit/propose/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/storyboard/shotsfree
POST/agent/v1/api/projects/{id}/storyboard/splitfree
POST/agent/v1/api/projects/{id}/storyboard/split/dismissfree

cut-reply-routes: Reply on a cut's offer: its quote and its paid answer

The routes in cut-reply-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/storyboard/cut-replypaid (credits held first)
POST/agent/v1/api/projects/{id}/storyboard/cut-reply/quotequote (free; nothing held)

help-draft-routes: Help draft's quote and its paid new version

The routes in help-draft-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/storyboard/help-draftpaid (credits held first)
POST/agent/v1/api/projects/{id}/storyboard/help-draft/quotequote (free; nothing held)
GET/agent/v1/api/projects/{id}/storyboard/help-draft/threadfree
POST/agent/v1/api/projects/{id}/storyboard/help-draft/threadfree
POST/agent/v1/api/projects/{id}/storyboard/help-draft/thread/start-overfree
POST/agent/v1/api/projects/{id}/storyboard/help-draft/thread/undo-start-overfree

move-end-reply-routes: Reply on a move's end: its quote and its paid answer

The routes in move-end-reply-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/storyboard/move-end/replypaid (credits held first)
POST/agent/v1/api/projects/{id}/storyboard/move-end/reply/quotequote (free; nothing held)

board-make-routes: the new-shot panel's quote, Make it, the waiting stills

The routes in board-make-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/storyboard/panels/makesfree
POST/agent/v1/api/projects/{id}/storyboard/panels/quotequote (free; nothing held)

plan-routes: OK the plan, Keep (free), Remake them (paid, its quote free)

The routes in plan-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/storyboard/plan/changes/{changeId}/undofree
POST/agent/v1/api/projects/{id}/storyboard/plan/keepfree
POST/agent/v1/api/projects/{id}/storyboard/plan/places/{placeId}/okfree
POST/agent/v1/api/projects/{id}/storyboard/plan/places/{placeId}/ok/undofree
POST/agent/v1/api/projects/{id}/storyboard/plan/places/{placeId}/skipfree
POST/agent/v1/api/projects/{id}/storyboard/plan/places/{placeId}/skip/undofree
POST/agent/v1/api/projects/{id}/storyboard/plan/remakepaid (credits held first)
POST/agent/v1/api/projects/{id}/storyboard/plan/remake/quotequote (free; nothing held)

plan2-routes: Make this plate, the plan drawn from words (paid, quotes free)

The routes in plan2-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/storyboard/plan/drawpaid (credits held first)
POST/agent/v1/api/projects/{id}/storyboard/plan/draw/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/storyboard/plan/platepaid (credits held first)
POST/agent/v1/api/projects/{id}/storyboard/plan/plate/quotequote (free; nothing held)

style-routes: PUT / (free), POST /write (free), /brainstorm/quote, /brainstorm (paid), /palette (free), /remake/quote, /remake (paid)

The routes in style-routes
MethodPathMoneyOnly
PUT/agent/v1/api/projects/{id}/stylefree
POST/agent/v1/api/projects/{id}/style/brainstormpaid (credits held first)
POST/agent/v1/api/projects/{id}/style/brainstorm/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/style/palettefree
POST/agent/v1/api/projects/{id}/style/remakepaid (credits held first)
POST/agent/v1/api/projects/{id}/style/remake/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/style/writefree

agent-cuts: GET /take-sheet/:takeId, POST /cut-list (free)

The routes in agent-cuts
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/take-sheet/{takeId}free

take-whole-routes: a shot's takes of the whole shot, remake a part, Try again, join

The routes in take-whole-routes
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/takes/{takeId}/remakepaid (credits held first)
POST/agent/v1/api/projects/{id}/takes/{takeId}/remake/quotequote (free; nothing held)
POST/agent/v1/api/projects/{id}/takes/joinfree
POST/agent/v1/api/projects/{id}/takes/retrypaid (credits held first)
POST/agent/v1/api/projects/{id}/takes/retry/quotequote (free; nothing held)
GET/agent/v1/api/projects/{id}/takes/wholefree
POST/agent/v1/api/projects/{id}/takes/whole/{group}/cancelfree

theirs-routes: GET, PUT: "You're editing Costa's project. Duplicate the board?", once per project per person (their settings, free)

The routes in theirs-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/theirsfree
PUT/agent/v1/api/projects/{id}/theirsfree

production-tools: Propose coverage; for a scene of title cards only at BLACK, generate answers 200 { status: "cards-only", data: [] } with no id, and nothing is quoted, held or charged

The routes in production-tools
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/tools/framefree
POST/agent/v1/api/projects/{id}/tools/lutfree
GET/agent/v1/api/projects/{id}/tools/proposalsfree
POST/agent/v1/api/projects/{id}/tools/proposals/{action}paid (credits held first)
GET/agent/v1/api/projects/{id}/tools/proposals/{proposal}free
POST/agent/v1/api/projects/{id}/tools/proposals/{proposal}/reviewfree

media-uploads: POST, PUT /:uploadId/parts/:n, POST /:uploadId/finish, DELETE /:uploadId (free; /media below is unchanged)

The routes in media-uploads
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/uploadsfree
POST/agent/v1/api/projects/{id}/uploads/{uploadId}/finishfree
PUT/agent/v1/api/projects/{id}/uploads/{uploadId}/parts/{n}free

vertical-routes: GET/POST /renders/:jobId, PUT /centers; free

The routes in vertical-routes
MethodPathMoneyOnly
PUT/agent/v1/api/projects/{id}/vertical/centersfree
GET/agent/v1/api/projects/{id}/vertical/renders/{jobId}free
POST/agent/v1/api/projects/{id}/vertical/renders/{jobId}free

viewfinder-routes: read a framing and its sketch; start, camera, people, line, last frame, new shots, the page's ops (free)

The routes in viewfinder-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/viewfinder/{sceneId}free
POST/agent/v1/api/projects/{id}/viewfinder/{sceneId}/opsfree
PATCH/agent/v1/api/projects/{id}/viewfinder/{sceneId}/people/{tag}free
POST/agent/v1/api/projects/{id}/viewfinder/{sceneId}/people/{tag}/matchfree
POST/agent/v1/api/projects/{id}/viewfinder/{sceneId}/people/{tag}/movefree
POST/agent/v1/api/projects/{id}/viewfinder/{sceneId}/shotsfree
POST/agent/v1/api/projects/{id}/viewfinder/{sceneId}/shots/{draftId}/sendfree
GET/agent/v1/api/projects/{id}/viewfinder/{sceneId}/shots/{shotId}free
PATCH/agent/v1/api/projects/{id}/viewfinder/{sceneId}/shots/{shotId}/camerafree
POST/agent/v1/api/projects/{id}/viewfinder/{sceneId}/shots/{shotId}/last-framefree
POST/agent/v1/api/projects/{id}/viewfinder/{sceneId}/shots/{shotId}/linefree
PATCH/agent/v1/api/projects/{id}/viewfinder/{sceneId}/shots/{shotId}/people/{tag}free
POST/agent/v1/api/projects/{id}/viewfinder/{sceneId}/shots/{shotId}/sketchfree
POST/agent/v1/api/projects/{id}/viewfinder/{sceneId}/shots/{shotId}/startfree

voice

The routes in voice
MethodPathMoneyOnly
POST/agent/v1/api/projects/{id}/voicepaid (credits held first)
POST/agent/v1/api/projects/{id}/voice/quotequote (free; nothing held)

voice-over: GET, POST /quote (free), POST (paid)

The routes in voice-over
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/voice-overfree
POST/agent/v1/api/projects/{id}/voice-overpaid (credits held first)
POST/agent/v1/api/projects/{id}/voice-over/quotequote (free; nothing held)

wip-routes: GET, PUT /:tabId, POST /:tabId/discard|restore: the filmmaker's Work in progress tabs (free, their own)

The routes in wip-routes
MethodPathMoneyOnly
GET/agent/v1/api/projects/{id}/wipfree
PUT/agent/v1/api/projects/{id}/wip/{tabId}free
POST/agent/v1/api/projects/{id}/wip/{tabId}/discardfree
POST/agent/v1/api/projects/{id}/wip/{tabId}/restorefree

Reached only through a tool (11)

These routes build their request as the page does, so an agent calls the tool, not the route. A call at the door is refused with the tool's name.

Routes behind a tool
MethodRouteThe toolWhy
POST/api/projectscreate_project
POST/api/projects/:id/assets/:assetId/set-packnone from outsidethe Tarkovsky Director's make tool; no outside tool makes a set pack yet
POST/api/projects/:id/cut-listset_cuts
GET/api/projects/:id/directorget_run
POST/api/projects/:id/director/estimateestimate_film
POST/api/projects/:id/director/resumeresume_run
GET/api/projects/:id/director/runs/:rid/logget_run
POST/api/projects/:id/director/startstart_run
POST/api/projects/:id/director/stopstop_run
POST/api/projects/:id/storyboard/batchmake_still, make_takeone still or take at a time, through make_still and make_take
POST/api/projects/:id/storyboard/panels/makemake_stillthe new shot's still through make_still

The filmmaker's own (402)

Refused to every agent, at the door and through studio_request, with the reason below. The filmmaker does these in the studio.

The account, its keys, agent links, agreements and email are the filmmaker's.

  • GET /api/account/agent-links
  • POST /api/account/agent-links
  • PUT /api/account/agent-links/:id
  • POST /api/account/agent-links/:id/restore
  • GET /api/account/agreements
  • POST /api/account/agreements
  • PUT /api/account/agreements/improve
  • GET /api/account/ask-window
  • PUT /api/account/ask-window
  • GET /api/account/email
  • PUT /api/account/email
  • GET /api/account/licences/minimax-h3
  • POST /api/account/licences/minimax-h3
  • GET /api/account/members
  • PUT /api/account/members
  • POST /api/account/members/invite
  • GET /api/contacts
  • POST /api/contacts
  • PUT /api/contacts/:id
  • GET /api/keys
  • PUT /api/keys/:provider

An agent deletes nothing (DELETE is the filmmaker's, in the studio).

  • DELETE /api/account/agent-links/:id
  • DELETE /api/account/members
  • DELETE /api/admin/content-research/secrets/:name
  • DELETE /api/admin/social-apps/:app
  • DELETE /api/admin/youtube-setup
  • DELETE /api/gallery/series/:seriesId
  • DELETE /api/keys/:provider
  • DELETE /api/projects/:id/ask-takes/:rowId
  • DELETE /api/projects/:id/assets/:assetId/pictures/:imageId
  • DELETE /api/projects/:id/budget/share
  • DELETE /api/projects/:id/chat
  • DELETE /api/projects/:id/exports/set-asides/:sid
  • DELETE /api/projects/:id/floor-plans/:sceneId
  • DELETE /api/projects/:id/kickoff/script/auto
  • DELETE /api/projects/:id/members
  • DELETE /api/projects/:id/packages/:pid/listings/:listingId
  • DELETE /api/projects/:id/places/:placeId/joins/:joinId
  • POST /api/projects/:id/removed/still
  • POST /api/projects/:id/removed/take
  • DELETE /api/projects/:id/sequences/:sid
  • DELETE /api/projects/:id/uploads/:uploadId
  • DELETE /api/projects/:id/viewfinder/:sceneId/shots/:draftId
  • DELETE /api/projects/:id/viewfinder/:sceneId/shots/:shotId/last-frame

Administration is the studio's staff's, never an agent's.

  • POST /api/admin-invitations/accept
  • GET /api/admin/access
  • GET /api/admin/accounts/duplicates
  • POST /api/admin/accounts/duplicates/link
  • GET /api/admin/agent-runs
  • POST /api/admin/agent-runs/problems/:problem/approve
  • PUT /api/admin/agent-runs/settings
  • GET /api/admin/anatomy
  • PUT /api/admin/anatomy
  • GET /api/admin/anatomy/jobs/:jobId
  • GET /api/admin/answers-in-prompts
  • PUT /api/admin/answers-in-prompts
  • GET /api/admin/assistant
  • PUT /api/admin/assistant
  • GET /api/admin/caps
  • PUT /api/admin/caps/:key
  • GET /api/admin/caps/usage
  • GET /api/admin/cards
  • POST /api/admin/cards
  • GET /api/admin/cheapest-still-model
  • POST /api/admin/cheapest-still-model
  • GET /api/admin/commissions
  • POST /api/admin/commissions/:id/access-restored
  • POST /api/admin/commissions/:id/approve
  • POST /api/admin/commissions/:id/authorize
  • POST /api/admin/commissions/:id/balance-received
  • POST /api/admin/commissions/:id/cancel
  • GET /api/admin/commissions/:id/cancel-preview
  • POST /api/admin/commissions/:id/change
  • POST /api/admin/commissions/:id/change/withdraw
  • POST /api/admin/commissions/:id/check
  • POST /api/admin/commissions/:id/close
  • POST /api/admin/commissions/:id/decline
  • POST /api/admin/commissions/:id/defect
  • POST /api/admin/commissions/:id/defect-refuse
  • POST /api/admin/commissions/:id/quote
  • POST /api/admin/commissions/:id/review-copy
  • GET /api/admin/commissions/flow
  • GET /api/admin/commissions/onboarding
  • POST /api/admin/commissions/onboarding/:userId
  • GET /api/admin/commissions/records/:id
  • POST /api/admin/commissions/refunds/:refundId/made
  • POST /api/admin/commissions/refunds/:refundId/retry
  • POST /api/admin/commissions/shares/:shareId/paid
  • GET /api/admin/compute
  • POST /api/admin/content-research/candidates/:storyId/review
  • GET /api/admin/content-research/catalog
  • POST /api/admin/content-research/catalog/editions
  • GET /api/admin/content-research/channel
  • PUT /api/admin/content-research/channel
  • POST /api/admin/content-research/channel/autopilot
  • POST /api/admin/content-research/channel/run-now
  • GET /api/admin/content-research/commissions
  • POST /api/admin/content-research/commissions
  • POST /api/admin/content-research/commissions/:id/create-project
  • POST /api/admin/content-research/commissions/:id/link-publication
  • POST /api/admin/content-research/commissions/:id/stop
  • GET /api/admin/content-research/connections
  • PUT /api/admin/content-research/connections/:key
  • GET /api/admin/content-research/profiles
  • POST /api/admin/content-research/profiles
  • PATCH /api/admin/content-research/profiles/:id
  • GET /api/admin/content-research/results
  • POST /api/admin/content-research/results/import
  • GET /api/admin/content-research/runs
  • POST /api/admin/content-research/runs
  • GET /api/admin/content-research/runs/:id
  • POST /api/admin/content-research/runs/:id/cancel
  • POST /api/admin/content-research/runs/:id/import-trends
  • GET /api/admin/content-research/runs/:id/report.txt
  • POST /api/admin/content-research/runs/quote
  • PUT /api/admin/content-research/secrets/:name
  • GET /api/admin/continuity-critic
  • POST /api/admin/continuity-critic
  • GET /api/admin/critic
  • GET /api/admin/critic/agreement
  • POST /api/admin/critic/draft
  • POST /api/admin/critic/draft/quote
  • GET /api/admin/critic/drafts
  • GET /api/admin/critic/marks
  • PUT /api/admin/critic/marks
  • GET /api/admin/critic/passes
  • GET /api/admin/critic/passes/:id
  • PUT /api/admin/critic/passes/:id/reference
  • GET /api/admin/critic/references
  • GET /api/admin/critic/vault
  • GET /api/admin/critic/vault/block
  • GET /api/admin/critic/vault/built-in
  • POST /api/admin/critic/vault/entries
  • GET /api/admin/critic/vault/entries/:slug
  • PUT /api/admin/critic/vault/entries/:slug
  • POST /api/admin/critic/vault/entries/:slug/archive
  • POST /api/admin/critic/vault/entries/:slug/restore
  • GET /api/admin/critic/vault/releases
  • PUT /api/admin/critic/vault/switch
  • GET /api/admin/dailies-critic
  • POST /api/admin/dailies-critic
  • GET /api/admin/director
  • PUT /api/admin/director
  • GET /api/admin/director-thinking-room
  • POST /api/admin/director-thinking-room
  • PUT /api/admin/director/critic
  • GET /api/admin/director/endpoints
  • PUT /api/admin/director/endpoints
  • GET /api/admin/director/shot-by-shot
  • PUT /api/admin/director/shot-by-shot
  • GET /api/admin/director/shot-by-shot/projects/:pid
  • PUT /api/admin/director/shot-by-shot/projects/:pid
  • GET /api/admin/export
  • GET /api/admin/frame-sketch
  • POST /api/admin/frame-sketch
  • GET /api/admin/frame-sketch/stills
  • GET /api/admin/frame-sketch/stills/:jobId/:which
  • GET /api/admin/gallery
  • POST /api/admin/gallery/:listingId/feature
  • POST /api/admin/gallery/:listingId/publish
  • POST /api/admin/gallery/:listingId/remove
  • POST /api/admin/gallery/:listingId/restore
  • GET /api/admin/gallery/listings
  • GET /api/admin/gallery/payouts
  • POST /api/admin/gallery/payouts/:id/resolve
  • POST /api/admin/gallery/payouts/run
  • GET /api/admin/gallery/reports
  • POST /api/admin/gallery/reports/:reportId/dismiss
  • POST /api/admin/gallery/reports/:reportId/remove
  • POST /api/admin/gallery/switches/:key
  • POST /api/admin/holds/:id/release
  • POST /api/admin/invitations
  • POST /api/admin/invitations/:invite/revoke
  • GET /api/admin/job-sweep
  • PUT /api/admin/job-sweep
  • GET /api/admin/lock-relabel
  • POST /api/admin/lock-relabel
  • GET /api/admin/long-scripts
  • PUT /api/admin/long-scripts
  • GET /api/admin/media-cdn
  • PUT /api/admin/media-cdn
  • POST /api/admin/media-cdn/check
  • POST /api/admin/members/:member/revoke
  • GET /api/admin/minimax-h3-flash
  • PUT /api/admin/minimax-h3-flash
  • GET /api/admin/model-accounts
  • POST /api/admin/model-accounts
  • PUT /api/admin/model-accounts/:id
  • POST /api/admin/model-accounts/:id/archive
  • POST /api/admin/model-accounts/:id/refresh
  • POST /api/admin/model-accounts/:id/reveal
  • POST /api/admin/model-accounts/import-env
  • GET /api/admin/overview
  • GET /api/admin/platform-keys
  • POST /api/admin/platform-keys/read
  • PUT /api/admin/platform-keys/settings
  • GET /api/admin/production
  • POST /api/admin/production/asks/:askId/answered
  • POST /api/admin/production/jobs/:id/unbind
  • PUT /api/admin/production/makers
  • PUT /api/admin/production/models
  • GET /api/admin/prompt-versions
  • POST /api/admin/prompt-versions
  • GET /api/admin/refs-switches
  • POST /api/admin/refs-switches
  • GET /api/admin/render-farm
  • PUT /api/admin/render-farm/boards
  • PUT /api/admin/render-farm/export-rates
  • PUT /api/admin/render-farm/fade-from-black
  • PUT /api/admin/render-farm/frame-rates
  • POST /api/admin/render-farm/stop
  • PUT /api/admin/render-farm/switch
  • GET /api/admin/reports
  • GET /api/admin/reports/:id
  • POST /api/admin/reports/:id/answer
  • POST /api/admin/reports/:id/linear
  • POST /api/admin/reports/:id/triage
  • GET /api/admin/retake-fresh-refs
  • POST /api/admin/retake-fresh-refs
  • GET /api/admin/rights
  • POST /api/admin/rights/names
  • POST /api/admin/rights/switch
  • GET /api/admin/sample-film
  • PUT /api/admin/sample-film
  • GET /api/admin/scope-switches
  • PUT /api/admin/scope-switches
  • GET /api/admin/sketch
  • POST /api/admin/sketch/projects/:id
  • GET /api/admin/social-apps
  • PUT /api/admin/social-apps/:app
  • PUT /api/admin/social-apps/switch/:platform
  • GET /api/admin/speed
  • PUT /api/admin/speed/:key
  • POST /api/admin/speed/copies-back
  • GET /api/admin/studio-key
  • POST /api/admin/studio-key/read
  • POST /api/admin/studio-key/runs/:id/reopen
  • PUT /api/admin/studio-key/settings
  • GET /api/admin/titles
  • POST /api/admin/titles
  • GET /api/admin/titles3
  • POST /api/admin/titles3
  • GET /api/admin/uncapped
  • PUT /api/admin/uncapped
  • GET /api/admin/uncapped/users/:id
  • PUT /api/admin/uncapped/users/:id
  • GET /api/admin/users
  • GET /api/admin/users/:id
  • PUT /api/admin/users/:id
  • POST /api/admin/users/:id/credits
  • GET /api/admin/users/:id/deletion
  • POST /api/admin/users/:id/deletion
  • PUT /api/admin/users/:id/plan
  • PUT /api/admin/users/:id/storage
  • GET /api/admin/vault
  • GET /api/admin/vault/block
  • GET /api/admin/vault/built-in
  • POST /api/admin/vault/entries
  • GET /api/admin/vault/entries/:slug
  • PUT /api/admin/vault/entries/:slug
  • POST /api/admin/vault/entries/:slug/archive
  • POST /api/admin/vault/entries/:slug/restore
  • GET /api/admin/vault/releases
  • PUT /api/admin/vault/switch
  • GET /api/admin/vertical-cut
  • PUT /api/admin/vertical-cut
  • GET /api/admin/video-models
  • GET /api/admin/welcome-email
  • POST /api/admin/welcome-email/switch
  • POST /api/admin/welcome-email/test
  • GET /api/admin/youtube-setup
  • PUT /api/admin/youtube-setup

Purchases, top-ups, earnings and payouts are the filmmaker's, on the site.

  • POST /api/billing/auto-topup
  • POST /api/billing/auto-topup/off
  • POST /api/billing/card
  • POST /api/billing/card/remove
  • POST /api/billing/checkout
  • POST /api/billing/portal
  • GET /api/gallery/access/:listingId
  • GET /api/gallery/access/series/:seriesId
  • POST /api/gallery/buy
  • POST /api/gallery/connect
  • POST /api/gallery/connect/webhook
  • GET /api/gallery/earnings
  • PUT /api/gallery/listings/:id/price
  • GET /api/gallery/money/project/:projectId
  • GET /api/gallery/money/status
  • POST /api/gallery/tip

Outside the projects, only the session, billing, the model catalogs and the free quotes are open to an agent.

  • POST /api/billing/plan
  • POST /api/billing/plan/quote
  • POST /api/billing/refresh
  • GET /api/boot
  • POST /api/client-crash
  • POST /api/help/chat
  • GET /api/models/:provider
  • PUT /api/models/defaults
  • POST /api/palette/file
  • POST /api/palette/words
  • POST /api/reports
  • GET /api/reports/:id/screenshot
  • POST /api/reports/:id/seen
  • GET /api/reports/mine
  • GET /api/self-hosted/status
  • GET /api/social/callback/:app
  • GET /api/social/channels
  • PATCH /api/social/channels/:id
  • POST /api/social/channels/:id/disconnect
  • GET /api/social/channels/:id/tiktok
  • POST /api/social/connect
  • POST /api/social/posts
  • POST /api/social/posts/:id/cancel
  • POST /api/social/posts/:id/take-down
  • GET /api/social/project/:projectId
  • POST /api/social/renders/:mediaId/final
  • POST /api/social/uploads/:id/resume

Messages to people outside the studio are the filmmaker's.

  • POST /api/contact
  • GET /api/gallery/commissions
  • POST /api/gallery/commissions
  • GET /api/gallery/commissions/:id
  • POST /api/gallery/commissions/:id/accept
  • POST /api/gallery/commissions/:id/access
  • POST /api/gallery/commissions/:id/approve
  • POST /api/gallery/commissions/:id/balance
  • POST /api/gallery/commissions/:id/cancel
  • POST /api/gallery/commissions/:id/changes/decline
  • POST /api/gallery/commissions/:id/decline
  • POST /api/gallery/commissions/:id/deliver
  • GET /api/gallery/commissions/:id/delivery
  • POST /api/gallery/commissions/:id/deposit
  • POST /api/gallery/commissions/:id/revise
  • GET /api/gallery/commissions/business
  • PUT /api/gallery/commissions/business
  • PUT /api/gallery/commissions/open
  • GET /api/gallery/commissions/records
  • GET /api/gallery/commissions/records/:id
  • GET /api/gallery/commissions/statement
  • GET /api/gallery/commissions/terms-text
  • GET /api/gallery/follow
  • POST /api/gallery/follow
  • POST /api/gallery/fork/:listingId
  • POST /api/gallery/listings/:id/hide
  • POST /api/gallery/listings/:id/private
  • POST /api/gallery/listings/:id/private/link
  • POST /api/gallery/listings/:id/private/off
  • PUT /api/gallery/listings/:id/private/password
  • POST /api/gallery/listings/:id/private/previews
  • POST /api/gallery/listings/:id/private/previews/:linkId/revoke
  • POST /api/gallery/listings/:id/private/update
  • POST /api/gallery/listings/:id/show
  • GET /api/gallery/me
  • PUT /api/gallery/me
  • GET /api/gallery/mine
  • GET /api/gallery/private
  • GET /api/gallery/producer
  • POST /api/gallery/producer
  • PUT /api/gallery/producer/details
  • GET /api/gallery/producer/text
  • GET /api/gallery/production/:id
  • POST /api/gallery/production/:id/ask
  • GET /api/gallery/production/:id/delivery-check
  • POST /api/gallery/production/:id/project
  • GET /api/gallery/production/:id/provenance
  • POST /api/gallery/report/:listingId
  • GET /api/gallery/series
  • POST /api/gallery/series
  • PUT /api/gallery/series/:seriesId
  • GET /api/gallery/viewer/:listingId
  • GET /api/gallery/youtube
  • GET /api/gallery/youtube/callback
  • POST /api/gallery/youtube/connect
  • POST /api/gallery/youtube/disconnect
  • POST /api/gallery/youtube/upload
  • POST /api/gallery/youtube/uploads/:id/resume
  • POST /api/projects/:id/gallery
  • PUT /api/projects/:id/gallery/:listingId
  • POST /api/projects/:id/gallery/:listingId/poster
  • POST /api/projects/:id/gallery/:listingId/preview
  • POST /api/projects/:id/gallery/:listingId/submit
  • POST /api/projects/:id/gallery/:listingId/unpublish
  • POST /api/projects/:id/packages
  • PUT /api/projects/:id/packages/:pid/listings/:listingId
  • POST /api/projects/:id/screeners
  • POST /api/projects/:id/screeners/:sid/revoke

Only a filmmaker answers a flag.

  • POST /api/projects/:id/agent/flags/answer

An agent run (its decision log and report) is opened and finished by Tarkovsky Director or the filmmaker in the studio; an outside agent's calls are kept on its link.

  • POST /api/projects/:id/agent/runs
  • POST /api/projects/:id/agent/runs/:run/finish

Members, sharing, invitations, archiving and copies are the filmmaker's.

  • POST /api/projects/:id/archive
  • PUT /api/projects/:id/budget/share
  • POST /api/projects/:id/duplicate
  • GET /api/projects/:id/members
  • PUT /api/projects/:id/members
  • POST /api/projects/:id/members/invite

Marks on the Critic's notes are a person's word on them.

  • GET /api/projects/:id/critic/marks
  • PUT /api/projects/:id/critic/marks

The Director's own routes are its tools' (start_run, get_run, stop_run, resume_run, estimate_film).

  • GET /api/projects/:id/director/runs/:rid/flags
  • GET /api/projects/:id/director/runs/:rid/report.pdf
  • POST /api/projects/:id/director/runs/:rid/shots/:shotId/again

The kickoff's synopsis and concept buttons are the filmmaker's; POST /kickoff/script writes them first, within your budget.

  • POST /api/projects/:id/kickoff/concept
  • POST /api/projects/:id/kickoff/synopsis

Confirming the rights to a picture is the filmmaker's own word.

  • POST /api/projects/:id/rights/brief
  • POST /api/projects/:id/rights/media/:mediaId
  • POST /api/projects/:id/rights/person

How this page stays current

This page is written from the code that serves the API, at version 0.72: the tools, the route list, the scopes and the limits. The route list is read from the app itself, and a new route that isn't classed open, tool or the filmmaker's fails the build. This page and its Markdown twin are written again with every release, and the build fails while they differ from the code (AGENTS.md §7).