Filmsquare AideDocs

6.0 API6.3 Référence OpenAPI

Référence OpenAPI

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.

Mis à jour 3 min de lecture.md

Sur cette page
  1. Lire le document
  2. L'API par domaine
  3. Ce qui n'est pas dans le document
  4. La chercher avec des mots
  5. À lire aussi

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.

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

Lire le document #

ChampSignification
pathsChemins complets, commençant par /v1. Utilisez-les avec l'hôte https://app.filmsquare.ai
operationIdUn nom stable par route, comme generateForShot. Le même nom est l'action que votre Claude exécute avec run_action
summaryUne ligne sur ce que fait la route. C'est aussi ce que cherche find_actions
x-min-roleLe 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
securitybearerAuth (une clé d'API fsk_… ou un jeton de session), ou vide pour les routes publiques
tagsLe domaine de l'API, comme shots, takes, elements, credits
Réponses d'erreurChaque 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 #

DomaineExemples (operationId)
Compte et espaces de travailgetMe, listWorkspaces, createWorkspace, listMembers, createInvitation, setMemberScope
Productions et structurelistProjects, createProject, createEpisode, createScene, createShot, addShotToEpisode, getEpisodeStructure
Scénario et dépouillementimportScript, createScriptRevision, submitBreakdown, getEpisodeScript, listScriptRevisions
Tags du scénariolistScriptTags, autoTagScript, createScriptTag, updateScriptTag, archiveScriptTag, createElementFromScriptTag
Départements et validationlistProductionSteps, updateProductionStep, addProductionStep, getEpisodeSteps, requestSignoff, decideSignoff, listWaitingOnMe, getAnimaticReel
Prises et rendusestimateShotGeneration, generateForShot, generateForScene, promoteGeneration, rerollTake, retryGeneration, cancelGeneration, listGenerations, getGeneration, selectTake, listTools, estimateTool, applyTool
ÉlémentscreateElement, createQuickElement, forkElementVersion, generateForElement, acceptElementTake, searchHandles
Looks de costumelistEpisodeLooks, createElementLook, updateElementLook, archiveElementLook, setLookScene
Mise en place 3DgetEpisodeBlocking, pushBlockingFrame, pushBlockingFrames, listPrevisClips, addPrevisClips, countPrevisClip, archivePrevisClip, moveTake, moveAsset, findShotByCode, setShotExternalCodes, estimateBlockingStill, makeBlockingStill
FichierscreateUploadTicket, startMultipartUpload, signUploadPart, completeMultipartUpload, abortMultipartUpload, getMultipartUpload, completeUpload, importFromUrls, getAssetVersionUrl, getAssetVersionLineage, exportEpisodeManifest
RevuelistThreads, createThread, addThreadMessage, carryThreadForward, getInbox, markInboxRead, getActivity
Versions de montagelistEdits, createEdit, getEdit, addEditVersion
Le montagegetEpisodeCut, setCutClipTrim, reorderEpisodeCut, reviseTake, createCutExport, listCutExports
Raccords et routagegetContinuitySheet, scanContinuity, recordContinuityCheck, getModelAcceptance
Dossiers et canevaslistFolders, createFolder, addFolderItems, getCanvas, applyCanvasOps, runCanvasNode
Briefs et makerscreateBrief, offerAssignment, submitDelivery, markAssignmentPaid, getMakersOverview
Coûts et créditsgetEpisodeCosts, getCredits, listCreditEntries, getPricing, getPlan, listInvoices
IntégrationcreateApiKey, 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.
  • 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.

Avec Claude

MCP

Votre propre Claude le fait via MCP, en votre nom et avec votre rôle :

  • find_actions

    Cherche dans tout ce que l'API sait faire et renvoie les actions correspondantes avec leurs paramètres.

    Demandez : Trouve l'action qui change la règle de validation d'une étape.

Connecter Claude 5.1

Cette page en Markdown: /docs/fr/api/openapi.md