---
title: "Référence OpenAPI"
description: "Où se trouve le document OpenAPI 3.1 de Filmsquare, comment le lire (operation ids, x-min-role, tags), et une carte de l'API par domaine."
url: https://www.filmsquare.ai/docs/fr/api/openapi/
lang: fr
section: api
updated: 2026-11-10
mcp: [find_actions]
---

# Référence OpenAPI

La référence complète de l'API est un seul document OpenAPI 3.1, généré à partir des routes elles-mêmes, donc jamais
obsolète :

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

Il est public : aucun jeton nécessaire.

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

## Lire le document

| Champ | Signification |
| --- | --- |
| `paths` | Chemins complets, commençant par `/v1`. Utilisez-les avec l'hôte `https://app.filmsquare.ai` |
| `operationId` | Un nom stable par route, comme `generateForShot`. Le même nom est l'`action` que votre Claude exécute avec `run_action` |
| `summary` | Une ligne sur ce que fait la route. C'est aussi ce que cherche `find_actions` |
| `x-min-role` | Le rôle d'espace de travail le plus bas qui peut l'appeler : `viewer` … `owner`, `authenticated` (tout appelant connecté, sans espace de travail) ou `public` |
| `security` | `bearerAuth` (une clé d'API `fsk_…` ou un jeton de session), ou vide pour les routes publiques |
| `tags` | Le domaine de l'API, comme `shots`, `takes`, `elements`, `credits` |
| Réponses d'erreur | Chaque route liste le schéma `Error` partagé : `{"error": {"code", "message", "details"}}` |

Importez-le dans n'importe quel outil OpenAPI (Postman, Insomnia, Bruno) ou générez-en un client typé, par exemple avec
`openapi-typescript`.

## L'API par domaine

| Domaine | Exemples (`operationId`) |
| --- | --- |
| Compte et espaces de travail | `getMe`, `listWorkspaces`, `createWorkspace`, `listMembers`, `createInvitation`, `setMemberScope` |
| Productions et structure | `listProjects`, `createProject`, `createEpisode`, `createScene`, `createShot`, `addShotToEpisode`, `getEpisodeStructure` |
| Scénario et dépouillement | `importScript`, `createScriptRevision`, `submitBreakdown`, `getEpisodeScript`, `listScriptRevisions` |
| Tags du scénario | `listScriptTags`, `autoTagScript`, `createScriptTag`, `updateScriptTag`, `archiveScriptTag`, `createElementFromScriptTag` |
| Départements et validation | `listProductionSteps`, `updateProductionStep`, `addProductionStep`, `getEpisodeSteps`, `requestSignoff`, `decideSignoff`, `listWaitingOnMe`, `getAnimaticReel` |
| Prises et rendus | `estimateShotGeneration`, `generateForShot`, `generateForScene`, `promoteGeneration`, `rerollTake`, `retryGeneration`, `cancelGeneration`, `listGenerations`, `getGeneration`, `selectTake`, `listTools`, `estimateTool`, `applyTool` |
| Éléments | `createElement`, `createQuickElement`, `forkElementVersion`, `generateForElement`, `acceptElementTake`, `searchHandles` |
| Looks de costume | `listEpisodeLooks`, `createElementLook`, `updateElementLook`, `archiveElementLook`, `setLookScene` |
| Mise en place 3D | `getEpisodeBlocking`, `pushBlockingFrame`, `pushBlockingFrames`, `listPrevisClips`, `addPrevisClips`, `countPrevisClip`, `archivePrevisClip`, `moveTake`, `moveAsset`, `findShotByCode`, `setShotExternalCodes`, `estimateBlockingStill`, `makeBlockingStill` |
| Fichiers | `createUploadTicket`, `startMultipartUpload`, `signUploadPart`, `completeMultipartUpload`, `abortMultipartUpload`, `getMultipartUpload`, `completeUpload`, `importFromUrls`, `getAssetVersionUrl`, `getAssetVersionLineage`, `exportEpisodeManifest` |
| Revue | `listThreads`, `createThread`, `addThreadMessage`, `carryThreadForward`, `getInbox`, `markInboxRead`, `getActivity` |
| Versions de montage | `listEdits`, `createEdit`, `getEdit`, `addEditVersion` |
| Le montage | `getEpisodeCut`, `setCutClipTrim`, `reorderEpisodeCut`, `reviseTake`, `createCutExport`, `listCutExports` |
| Raccords et routage | `getContinuitySheet`, `scanContinuity`, `recordContinuityCheck`, `getModelAcceptance` |
| Dossiers et canevas | `listFolders`, `createFolder`, `addFolderItems`, `getCanvas`, `applyCanvasOps`, `runCanvasNode` |
| Briefs et makers | `createBrief`, `offerAssignment`, `submitDelivery`, `markAssignmentPaid`, `getMakersOverview` |
| Coûts et crédits | `getEpisodeCosts`, `getCredits`, `listCreditEntries`, `getPricing`, `getPlan`, `listInvoices` |
| Intégration | `createApiKey`, `revokeApiKey`, `createWebhook`, `updateWebhook`, `deleteWebhook` |

`GET /v1/pricing` (`getPricing`) est publique : le prix du crédit, les formules et les packs, en direct.

## Ce qui n'est pas dans le document

- Le point d'accès MCP `POST /v1/mcp`. Voir [Connecter Claude](https://www.filmsquare.ai/docs/fr/claude/connect/).
- Les points d'accès OAuth des connexions Claude (`/oauth/*`, `/.well-known/oauth-*`).
- Les sockets temps réel des canevas et de la présence (`/v1/realtime/…`) ; ils s'ouvrent avec un ticket de courte durée
  issu de `createCanvasSession` ou `createProjectPresenceSession`.

## La chercher avec des mots

`find_actions` cherche dans le même catalogue avec le vocabulaire du tournage (« pick take », « notes », « render »). Vous
pouvez l'utiliser depuis votre propre Claude sans lire le document du tout. Voir [Ce que Claude peut faire](https://www.filmsquare.ai/docs/fr/claude/tools/).

## À lire aussi

- [Aperçu de l'API et clés](https://www.filmsquare.ai/docs/fr/api/overview/)
- [Webhooks](https://www.filmsquare.ai/docs/fr/api/webhooks/)
