Filmsquare HilfeDocs

6.0 API6.3 OpenAPI-Referenz

OpenAPI-Referenz

Wo das OpenAPI-3.1-Dokument von Filmsquare liegt, wie du es liest (Operation-IDs, x-min-role, Tags), und eine Karte der API nach Bereichen.

Aktualisiert 2 Min. Lesezeit.md

Auf dieser Seite
  1. Das Dokument lesen
  2. Die API nach Bereichen
  3. Was nicht im Dokument steht
  4. In Worten suchen
  5. Verwandt

Die vollständige Referenz der API ist ein OpenAPI-3.1-Dokument, aus den Routen selbst erzeugt, damit es nie überholt ist:

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

Es ist öffentlich: kein Token nötig.

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

Das Dokument lesen #

FeldBedeutung
pathsVollständige Pfade, beginnend mit /v1. Nutze sie mit dem Host https://app.filmsquare.ai
operationIdEin stabiler Name pro Route, etwa generateForShot. Derselbe Name ist die action, die dein Claude mit run_action ausführt
summaryEine Zeile dazu, was die Route tut. Das ist auch das, was find_actions durchsucht
x-min-roleDie niedrigste Workspace-Rolle, die sie aufrufen darf: viewer … owner, authenticated (jeder angemeldete Aufrufer, kein Workspace) oder public
securitybearerAuth (ein API-Schlüssel fsk_… oder ein Session-Token) oder leer bei öffentlichen Routen
tagsDer Bereich der API, etwa shots, takes, elements, credits
FehlerantwortenJede Route listet das gemeinsame Schema Error: {"error": {"code", "message", "details"}}

Importiere es in ein beliebiges OpenAPI-Tool (Postman, Insomnia, Bruno) oder erzeuge daraus einen typisierten Client, zum Beispiel mit openapi-typescript.

Die API nach Bereichen #

BereichBeispiele (operationId)
Konto und WorkspacesgetMe, listWorkspaces, createWorkspace, listMembers, createInvitation, setMemberScope
Produktionen und StrukturlistProjects, createProject, createEpisode, createScene, createShot, addShotToEpisode, getEpisodeStructure
Drehbuch und DrehbuchauszugimportScript, createScriptRevision, submitBreakdown, getEpisodeScript, listScriptRevisions
Drehbuch-TagslistScriptTags, autoTagScript, createScriptTag, updateScriptTag, archiveScriptTag, createElementFromScriptTag
Gewerke und AbnahmelistProductionSteps, updateProductionStep, addProductionStep, getEpisodeSteps, requestSignoff, decideSignoff, listWaitingOnMe, getAnimaticReel
Takes und GenerierungenestimateShotGeneration, generateForShot, generateForScene, promoteGeneration, rerollTake, retryGeneration, cancelGeneration, listGenerations, getGeneration, selectTake, listTools, estimateTool, applyTool
ElementecreateElement, createQuickElement, forkElementVersion, generateForElement, acceptElementTake, searchHandles
Kostüm-LookslistEpisodeLooks, createElementLook, updateElementLook, archiveElementLook, setLookScene
3D-BlockinggetEpisodeBlocking, pushBlockingFrame, pushBlockingFrames, listPrevisClips, addPrevisClips, countPrevisClip, archivePrevisClip, moveTake, moveAsset, findShotByCode, setShotExternalCodes, estimateBlockingStill, makeBlockingStill
DateiencreateUploadTicket, startMultipartUpload, signUploadPart, completeMultipartUpload, abortMultipartUpload, getMultipartUpload, completeUpload, importFromUrls, getAssetVersionUrl, getAssetVersionLineage, exportEpisodeManifest
ReviewlistThreads, createThread, addThreadMessage, carryThreadForward, getInbox, markInboxRead, getActivity
SchnittfassungenlistEdits, createEdit, getEdit, addEditVersion
Der SchnittgetEpisodeCut, setCutClipTrim, reorderEpisodeCut, reviseTake, createCutExport, listCutExports
Continuity und RoutinggetContinuitySheet, scanContinuity, recordContinuityCheck, getModelAcceptance
Ordner und CanvaseslistFolders, createFolder, addFolderItems, getCanvas, applyCanvasOps, runCanvasNode
Briefings und MakerscreateBrief, offerAssignment, submitDelivery, markAssignmentPaid, getMakersOverview
Kosten und CreditsgetEpisodeCosts, getCredits, listCreditEntries, getPricing, getPlan, listInvoices
IntegrationcreateApiKey, revokeApiKey, createWebhook, updateWebhook, deleteWebhook

GET /v1/pricing (getPricing) ist öffentlich: der Credit-Preis, die Tarife und die Pakete, live.

Was nicht im Dokument steht #

  • Der MCP-Endpoint POST /v1/mcp. Siehe Claude verbinden.
  • Die OAuth-Endpoints für Claude-Verbindungen (/oauth/*, /.well-known/oauth-*).
  • Die Realtime-Sockets für Canvases und Presence (/v1/realtime/…); sie öffnen mit einem kurzlebigen Ticket von createCanvasSession oder createProjectPresenceSession.

In Worten suchen #

find_actions durchsucht denselben Katalog in Set-Sprache („pick take“, „notes“, „render“). Du kannst es aus deinem eigenen Claude nutzen, ohne das Dokument überhaupt zu lesen. Siehe Was Claude kann.

Mit Claude

MCP

Dein eigener Claude macht das über MCP, in deinem Namen und mit deiner Rolle:

  • find_actions

    Durchsucht alles, was die API kann, und liefert die passenden Aktionen mit ihren Eingaben.

    Frag: Finde die Aktion, die die Abnahmeregel eines Schritts ändert.

Claude verbinden 5.1

Diese Seite als Markdown: /docs/de/api/openapi.md