---
title: "OpenAPI-Referenz"
description: "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."
url: https://www.filmsquare.ai/docs/de/api/openapi/
lang: de
section: api
updated: 2026-11-10
mcp: [find_actions]
---

# OpenAPI-Referenz

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.

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

## Das Dokument lesen

| Feld | Bedeutung |
| --- | --- |
| `paths` | Vollständige Pfade, beginnend mit `/v1`. Nutze sie mit dem Host `https://app.filmsquare.ai` |
| `operationId` | Ein stabiler Name pro Route, etwa `generateForShot`. Derselbe Name ist die `action`, die dein Claude mit `run_action` ausführt |
| `summary` | Eine Zeile dazu, was die Route tut. Das ist auch das, was `find_actions` durchsucht |
| `x-min-role` | Die niedrigste Workspace-Rolle, die sie aufrufen darf: `viewer` … `owner`, `authenticated` (jeder angemeldete Aufrufer, kein Workspace) oder `public` |
| `security` | `bearerAuth` (ein API-Schlüssel `fsk_…` oder ein Session-Token) oder leer bei öffentlichen Routen |
| `tags` | Der Bereich der API, etwa `shots`, `takes`, `elements`, `credits` |
| Fehlerantworten | Jede 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

| Bereich | Beispiele (`operationId`) |
| --- | --- |
| Konto und Workspaces | `getMe`, `listWorkspaces`, `createWorkspace`, `listMembers`, `createInvitation`, `setMemberScope` |
| Produktionen und Struktur | `listProjects`, `createProject`, `createEpisode`, `createScene`, `createShot`, `addShotToEpisode`, `getEpisodeStructure` |
| Drehbuch und Drehbuchauszug | `importScript`, `createScriptRevision`, `submitBreakdown`, `getEpisodeScript`, `listScriptRevisions` |
| Drehbuch-Tags | `listScriptTags`, `autoTagScript`, `createScriptTag`, `updateScriptTag`, `archiveScriptTag`, `createElementFromScriptTag` |
| Gewerke und Abnahme | `listProductionSteps`, `updateProductionStep`, `addProductionStep`, `getEpisodeSteps`, `requestSignoff`, `decideSignoff`, `listWaitingOnMe`, `getAnimaticReel` |
| Takes und Generierungen | `estimateShotGeneration`, `generateForShot`, `generateForScene`, `promoteGeneration`, `rerollTake`, `retryGeneration`, `cancelGeneration`, `listGenerations`, `getGeneration`, `selectTake`, `listTools`, `estimateTool`, `applyTool` |
| Elemente | `createElement`, `createQuickElement`, `forkElementVersion`, `generateForElement`, `acceptElementTake`, `searchHandles` |
| Kostüm-Looks | `listEpisodeLooks`, `createElementLook`, `updateElementLook`, `archiveElementLook`, `setLookScene` |
| 3D-Blocking | `getEpisodeBlocking`, `pushBlockingFrame`, `pushBlockingFrames`, `listPrevisClips`, `addPrevisClips`, `countPrevisClip`, `archivePrevisClip`, `moveTake`, `moveAsset`, `findShotByCode`, `setShotExternalCodes`, `estimateBlockingStill`, `makeBlockingStill` |
| Dateien | `createUploadTicket`, `startMultipartUpload`, `signUploadPart`, `completeMultipartUpload`, `abortMultipartUpload`, `getMultipartUpload`, `completeUpload`, `importFromUrls`, `getAssetVersionUrl`, `getAssetVersionLineage`, `exportEpisodeManifest` |
| Review | `listThreads`, `createThread`, `addThreadMessage`, `carryThreadForward`, `getInbox`, `markInboxRead`, `getActivity` |
| Schnittfassungen | `listEdits`, `createEdit`, `getEdit`, `addEditVersion` |
| Der Schnitt | `getEpisodeCut`, `setCutClipTrim`, `reorderEpisodeCut`, `reviseTake`, `createCutExport`, `listCutExports` |
| Continuity und Routing | `getContinuitySheet`, `scanContinuity`, `recordContinuityCheck`, `getModelAcceptance` |
| Ordner und Canvases | `listFolders`, `createFolder`, `addFolderItems`, `getCanvas`, `applyCanvasOps`, `runCanvasNode` |
| Briefings und Makers | `createBrief`, `offerAssignment`, `submitDelivery`, `markAssignmentPaid`, `getMakersOverview` |
| Kosten und Credits | `getEpisodeCosts`, `getCredits`, `listCreditEntries`, `getPricing`, `getPlan`, `listInvoices` |
| Integration | `createApiKey`, `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](https://www.filmsquare.ai/docs/de/claude/connect/).
- 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](https://www.filmsquare.ai/docs/de/claude/tools/).

## Verwandt

- [API-Überblick und Schlüssel](https://www.filmsquare.ai/docs/de/api/overview/)
- [Webhooks](https://www.filmsquare.ai/docs/de/api/webhooks/)
