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

# OpenAPI-referentie

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.

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

## Het document lezen

| Veld | Betekenis |
| --- | --- |
| `paths` | Volledige paden, beginnend met `/v1`. Gebruik ze met de host `https://app.filmsquare.ai` |
| `operationId` | Een vaste naam per route, zoals `generateForShot`. Dezelfde naam is de `action` die je Claude uitvoert met `run_action` |
| `summary` | Eén regel over wat de route doet. Het is ook waarin `find_actions` zoekt |
| `x-min-role` | De laagste workspacerol die hem mag aanroepen: `viewer` … `owner`, `authenticated` (elke ingelogde aanroeper, geen workspace) of `public` |
| `security` | `bearerAuth` (een API-sleutel `fsk_…` of een sessietoken), of leeg voor openbare routes |
| `tags` | Het gebied van de API, zoals `shots`, `takes`, `elements`, `credits` |
| Foutantwoorden | Elke 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

| Gebied | Voorbeelden (`operationId`) |
| --- | --- |
| Account en workspaces | `getMe`, `listWorkspaces`, `createWorkspace`, `listMembers`, `createInvitation`, `setMemberScope` |
| Producties en structuur | `listProjects`, `createProject`, `createEpisode`, `createScene`, `createShot`, `addShotToEpisode`, `getEpisodeStructure` |
| Script en breakdown | `importScript`, `createScriptRevision`, `submitBreakdown`, `getEpisodeScript`, `listScriptRevisions` |
| Script-tags | `listScriptTags`, `autoTagScript`, `createScriptTag`, `updateScriptTag`, `archiveScriptTag`, `createElementFromScriptTag` |
| Departementen en aftekenen | `listProductionSteps`, `updateProductionStep`, `addProductionStep`, `getEpisodeSteps`, `requestSignoff`, `decideSignoff`, `listWaitingOnMe`, `getAnimaticReel` |
| Takes en generaties | `estimateShotGeneration`, `generateForShot`, `generateForScene`, `promoteGeneration`, `rerollTake`, `retryGeneration`, `cancelGeneration`, `listGenerations`, `getGeneration`, `selectTake`, `listTools`, `estimateTool`, `applyTool` |
| Elementen | `createElement`, `createQuickElement`, `forkElementVersion`, `generateForElement`, `acceptElementTake`, `searchHandles` |
| Kostuumlooks | `listEpisodeLooks`, `createElementLook`, `updateElementLook`, `archiveElementLook`, `setLookScene` |
| 3D-blocking | `getEpisodeBlocking`, `pushBlockingFrame`, `pushBlockingFrames`, `listPrevisClips`, `addPrevisClips`, `countPrevisClip`, `archivePrevisClip`, `moveTake`, `moveAsset`, `findShotByCode`, `setShotExternalCodes`, `estimateBlockingStill`, `makeBlockingStill` |
| Bestanden | `createUploadTicket`, `startMultipartUpload`, `signUploadPart`, `completeMultipartUpload`, `abortMultipartUpload`, `getMultipartUpload`, `completeUpload`, `importFromUrls`, `getAssetVersionUrl`, `getAssetVersionLineage`, `exportEpisodeManifest` |
| Review | `listThreads`, `createThread`, `addThreadMessage`, `carryThreadForward`, `getInbox`, `markInboxRead`, `getActivity` |
| Edits | `listEdits`, `createEdit`, `getEdit`, `addEditVersion` |
| De cut | `getEpisodeCut`, `setCutClipTrim`, `reorderEpisodeCut`, `reviseTake`, `createCutExport`, `listCutExports` |
| Continuïteit en routing | `getContinuitySheet`, `scanContinuity`, `recordContinuityCheck`, `getModelAcceptance` |
| Mappen en canvassen | `listFolders`, `createFolder`, `addFolderItems`, `getCanvas`, `applyCanvasOps`, `runCanvasNode` |
| Briefs en makers | `createBrief`, `offerAssignment`, `submitDelivery`, `markAssignmentPaid`, `getMakersOverview` |
| Kosten en credits | `getEpisodeCosts`, `getCredits`, `listCreditEntries`, `getPricing`, `getPlan`, `listInvoices` |
| Integratie | `createApiKey`, `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](https://www.filmsquare.ai/docs/nl/claude/connect/).
- 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](https://www.filmsquare.ai/docs/nl/claude/tools/).

## Gerelateerd

- [API-overzicht en sleutels](https://www.filmsquare.ai/docs/nl/api/overview/)
- [Webhooks](https://www.filmsquare.ai/docs/nl/api/webhooks/)
