Filmsquare HelpDocs

6.0 API6.3 OpenAPI-referentie

OpenAPI-referentie

Waar het OpenAPI 3.1-document van Filmsquare staat, hoe je het leest (operation ids, x-min-role, tags) en een kaart van de API per gebied.

Bijgewerkt 2 min lezen.md

Op deze pagina
  1. Het document lezen
  2. De API per gebied
  3. Wat niet in het document staat
  4. Zoek erin met woorden
  5. Gerelateerd

De volledige referentie van de API is één OpenAPI 3.1-document, gegenereerd uit de routes zelf, dus het loopt nooit achter:

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

Het is openbaar: geen token nodig.

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

Het document lezen #

VeldBetekenis
pathsVolledige paden, beginnend met /v1. Gebruik ze met de host https://app.filmsquare.ai
operationIdEen vaste naam per route, zoals generateForShot. Dezelfde naam is de action die je Claude uitvoert met run_action
summaryEén regel over wat de route doet. Het is ook waarin find_actions zoekt
x-min-roleDe laagste workspacerol die hem mag aanroepen: viewer … owner, authenticated (elke ingelogde aanroeper, geen workspace) of public
securitybearerAuth (een API-sleutel fsk_… of een sessietoken), of leeg voor openbare routes
tagsHet gebied van de API, zoals shots, takes, elements, credits
FoutantwoordenElke route noemt het gedeelde schema Error: {"error": {"code", "message", "details"}}

Importeer het in elke OpenAPI-tool (Postman, Insomnia, Bruno) of genereer er een getypte client uit, bijvoorbeeld met openapi-typescript.

De API per gebied #

GebiedVoorbeelden (operationId)
Account en workspacesgetMe, listWorkspaces, createWorkspace, listMembers, createInvitation, setMemberScope
Producties en structuurlistProjects, createProject, createEpisode, createScene, createShot, addShotToEpisode, getEpisodeStructure
Script en breakdownimportScript, createScriptRevision, submitBreakdown, getEpisodeScript, listScriptRevisions
Script-tagslistScriptTags, autoTagScript, createScriptTag, updateScriptTag, archiveScriptTag, createElementFromScriptTag
Departementen en aftekenenlistProductionSteps, updateProductionStep, addProductionStep, getEpisodeSteps, requestSignoff, decideSignoff, listWaitingOnMe, getAnimaticReel
Takes en generatiesestimateShotGeneration, generateForShot, generateForScene, promoteGeneration, rerollTake, retryGeneration, cancelGeneration, listGenerations, getGeneration, selectTake, listTools, estimateTool, applyTool
ElementencreateElement, createQuickElement, forkElementVersion, generateForElement, acceptElementTake, searchHandles
KostuumlookslistEpisodeLooks, createElementLook, updateElementLook, archiveElementLook, setLookScene
3D-blockinggetEpisodeBlocking, pushBlockingFrame, pushBlockingFrames, listPrevisClips, addPrevisClips, countPrevisClip, archivePrevisClip, moveTake, moveAsset, findShotByCode, setShotExternalCodes, estimateBlockingStill, makeBlockingStill
BestandencreateUploadTicket, startMultipartUpload, signUploadPart, completeMultipartUpload, abortMultipartUpload, getMultipartUpload, completeUpload, importFromUrls, getAssetVersionUrl, getAssetVersionLineage, exportEpisodeManifest
ReviewlistThreads, createThread, addThreadMessage, carryThreadForward, getInbox, markInboxRead, getActivity
EditslistEdits, createEdit, getEdit, addEditVersion
De cutgetEpisodeCut, setCutClipTrim, reorderEpisodeCut, reviseTake, createCutExport, listCutExports
Continuïteit en routinggetContinuitySheet, scanContinuity, recordContinuityCheck, getModelAcceptance
Mappen en canvassenlistFolders, createFolder, addFolderItems, getCanvas, applyCanvasOps, runCanvasNode
Briefs en makerscreateBrief, offerAssignment, submitDelivery, markAssignmentPaid, getMakersOverview
Kosten en creditsgetEpisodeCosts, getCredits, listCreditEntries, getPricing, getPlan, listInvoices
IntegratiecreateApiKey, revokeApiKey, createWebhook, updateWebhook, deleteWebhook

GET /v1/pricing (getPricing) is openbaar: de creditprijs, de abonnementen en de pakketten, live.

Wat niet in het document staat #

  • Het MCP-endpoint POST /v1/mcp. Zie Claude koppelen.
  • De OAuth-endpoints voor Claude-koppelingen (/oauth/*, /.well-known/oauth-*).
  • De realtime sockets voor canvassen en presence (/v1/realtime/…); ze openen met een kortlevend ticket van createCanvasSession of createProjectPresenceSession.

Zoek erin met woorden #

find_actions doorzoekt dezelfde catalogus in filmtaal ("pick take", "notes", "render"). Je kunt hem vanuit je eigen Claude gebruiken zonder het document ooit te lezen. Zie Wat Claude kan doen.

Met Claude

MCP

Je eigen Claude doet dit via MCP, op jouw naam en met jouw rol:

  • find_actions

    Doorzoekt alles wat de API kan en geeft de passende acties met hun invoer.

    Vraag: Zoek de actie die de aftekenregel van een stap wijzigt.

Claude koppelen 5.1

Deze pagina als Markdown: /docs/nl/api/openapi.md