Filmsquare HelpDocs

6.0 API6.3 OpenAPI reference

OpenAPI reference

Where the Filmsquare OpenAPI 3.1 document lives, how to read it (operation ids, x-min-role, tags), and a map of the API by area.

Updated 3 min read.md

On this page
  1. Reading the document
  2. The API by area
  3. What is not in the document
  4. Search it in words
  5. Related

The full reference of the API is one OpenAPI 3.1 document, generated from the routes themselves, so it is never out of date:

https://app.filmsquare.ai/v1/openapi.json

It is public: no token needed.

curl -s https://app.filmsquare.ai/v1/openapi.json | jq '.paths | keys | length'

Reading the document #

FieldMeaning
pathsFull paths, starting with /v1. Use them with the host https://app.filmsquare.ai
operationIdA stable name per route, such as generateForShot. The same name is the action your Claude runs with run_action
summaryOne line on what the route does. It is also what find_actions searches
x-min-roleThe lowest workspace role that may call it: viewer … owner, authenticated (any signed-in caller, no workspace) or public
securitybearerAuth (an API key fsk_… or a session token), or empty for public routes
tagsThe area of the API, such as shots, takes, elements, credits
Error responsesEvery route lists the shared Error schema: {"error": {"code", "message", "details"}}

Import it in any OpenAPI tool (Postman, Insomnia, Bruno) or generate a typed client from it, for example with openapi-typescript.

The API by area #

AreaExamples (operationId)
Account and workspacesgetMe, listWorkspaces, createWorkspace, listMembers, createInvitation, setMemberScope
Productions and structurelistProjects, createProject, createEpisode, createScene, createShot, addShotToEpisode, getEpisodeStructure
Script and breakdownimportScript, createScriptRevision, submitBreakdown, getEpisodeScript, listScriptRevisions
Script tagslistScriptTags, autoTagScript, createScriptTag, updateScriptTag, archiveScriptTag, createElementFromScriptTag
Departments and sign-offlistProductionSteps, updateProductionStep, addProductionStep, getEpisodeSteps, requestSignoff, decideSignoff, listWaitingOnMe, getAnimaticReel
Takes and generationsestimateShotGeneration, generateForShot, generateForScene, promoteGeneration, rerollTake, retryGeneration, cancelGeneration, listGenerations, getGeneration, selectTake, listTools, estimateTool, applyTool
ElementscreateElement, createQuickElement, forkElementVersion, generateForElement, acceptElementTake, searchHandles
Costume lookslistEpisodeLooks, createElementLook, updateElementLook, archiveElementLook, setLookScene
3D blockinggetEpisodeBlocking, pushBlockingFrame, pushBlockingFrames, listPrevisClips, addPrevisClips, countPrevisClip, archivePrevisClip, moveTake, moveAsset, findShotByCode, setShotExternalCodes, estimateBlockingStill, makeBlockingStill
FilescreateUploadTicket, startMultipartUpload, signUploadPart, completeMultipartUpload, abortMultipartUpload, getMultipartUpload, completeUpload, importFromUrls, getAssetVersionUrl, getAssetVersionLineage, exportEpisodeManifest
ReviewlistThreads, createThread, addThreadMessage, carryThreadForward, getInbox, markInboxRead, getActivity
EditslistEdits, createEdit, getEdit, addEditVersion
The cutgetEpisodeCut, setCutClipTrim, reorderEpisodeCut, reviseTake, createCutExport, listCutExports
Continuity and routinggetContinuitySheet, scanContinuity, recordContinuityCheck, getModelAcceptance
Folders and canvaseslistFolders, createFolder, addFolderItems, getCanvas, applyCanvasOps, runCanvasNode
Briefs and makerscreateBrief, offerAssignment, submitDelivery, markAssignmentPaid, getMakersOverview
Costs and creditsgetEpisodeCosts, getCredits, listCreditEntries, getPricing, getPlan, listInvoices
IntegrationcreateApiKey, revokeApiKey, createWebhook, updateWebhook, deleteWebhook

GET /v1/pricing (getPricing) is public: the credit price, the plans and the packs, live.

What is not in the document #

  • The MCP endpoint POST /v1/mcp. See Connect Claude.
  • The OAuth endpoints for Claude connections (/oauth/*, /.well-known/oauth-*).
  • The realtime sockets for canvases and presence (/v1/realtime/…); they open with a short-lived ticket from createCanvasSession or createProjectPresenceSession.

Search it in words #

find_actions searches the same catalogue in set language ("pick take", "notes", "render"). You can use it from your own Claude without reading the document at all. See What Claude can do.

With Claude

MCP

Your own Claude does this over MCP, in your name and with your role:

  • find_actions

    Searches everything the API can do and returns the matching actions with their inputs.

    Ask: Find the action that changes a step's sign-off rule.

Connect Claude 5.1

This page as Markdown: /docs/api/openapi.md