Filmsquare AiutoDocumentazione

6.0 API6.3 Riferimento OpenAPI

Riferimento OpenAPI

Dove sta il documento OpenAPI 3.1 di Filmsquare, come leggerlo (operation id, x-min-role, tag) e una mappa dell'API per area.

Aggiornato il 3 min di lettura.md

In questa pagina
  1. Leggere il documento
  2. L'API per area
  3. Cosa non c'è nel documento
  4. Cercalo a parole
  5. Correlati

Il riferimento completo dell'API è un unico documento OpenAPI 3.1, generato dalle rotte stesse, quindi non è mai indietro:

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

È pubblico: non serve nessun token.

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

Leggere il documento #

CampoSignificato
pathsPercorsi completi, che iniziano con /v1. Usali con l'host https://app.filmsquare.ai
operationIdUn nome stabile per rotta, come generateForShot. Lo stesso nome è l'action che il tuo Claude esegue con run_action
summaryUna riga su cosa fa la rotta. È anche ciò che cerca find_actions
x-min-roleIl ruolo più basso dello spazio di lavoro che può chiamarla: viewer … owner, authenticated (qualsiasi chiamante con l'accesso effettuato, senza spazio di lavoro) o public
securitybearerAuth (una chiave API fsk_… o un token di sessione), oppure vuoto per le rotte pubbliche
tagsL'area dell'API, come shots, takes, elements, credits
Risposte di erroreOgni rotta elenca lo schema Error condiviso: {"error": {"code", "message", "details"}}

Importalo in qualsiasi strumento OpenAPI (Postman, Insomnia, Bruno) oppure genera da esso un client tipizzato, per esempio con openapi-typescript.

L'API per area #

AreaEsempi (operationId)
Account e spazi di lavorogetMe, listWorkspaces, createWorkspace, listMembers, createInvitation, setMemberScope
Produzioni e strutturalistProjects, createProject, createEpisode, createScene, createShot, addShotToEpisode, getEpisodeStructure
Sceneggiatura e spoglioimportScript, createScriptRevision, submitBreakdown, getEpisodeScript, listScriptRevisions
Tag della sceneggiaturalistScriptTags, autoTagScript, createScriptTag, updateScriptTag, archiveScriptTag, createElementFromScriptTag
Reparti e approvazionelistProductionSteps, updateProductionStep, addProductionStep, getEpisodeSteps, requestSignoff, decideSignoff, listWaitingOnMe, getAnimaticReel
Ciak e generazioniestimateShotGeneration, generateForShot, generateForScene, promoteGeneration, rerollTake, retryGeneration, cancelGeneration, listGenerations, getGeneration, selectTake, listTools, estimateTool, applyTool
ElementicreateElement, createQuickElement, forkElementVersion, generateForElement, acceptElementTake, searchHandles
Look dei costumilistEpisodeLooks, createElementLook, updateElementLook, archiveElementLook, setLookScene
Blocking 3DgetEpisodeBlocking, pushBlockingFrame, pushBlockingFrames, listPrevisClips, addPrevisClips, countPrevisClip, archivePrevisClip, moveTake, moveAsset, findShotByCode, setShotExternalCodes, estimateBlockingStill, makeBlockingStill
FilecreateUploadTicket, startMultipartUpload, signUploadPart, completeMultipartUpload, abortMultipartUpload, getMultipartUpload, completeUpload, importFromUrls, getAssetVersionUrl, getAssetVersionLineage, exportEpisodeManifest
RevisionelistThreads, createThread, addThreadMessage, carryThreadForward, getInbox, markInboxRead, getActivity
Versioni di montaggiolistEdits, createEdit, getEdit, addEditVersion
Il montaggiogetEpisodeCut, setCutClipTrim, reorderEpisodeCut, reviseTake, createCutExport, listCutExports
Continuità e routinggetContinuitySheet, scanContinuity, recordContinuityCheck, getModelAcceptance
Cartelle e canvaslistFolders, createFolder, addFolderItems, getCanvas, applyCanvasOps, runCanvasNode
Brief e makercreateBrief, offerAssignment, submitDelivery, markAssignmentPaid, getMakersOverview
Costi e creditigetEpisodeCosts, getCredits, listCreditEntries, getPricing, getPlan, listInvoices
IntegrazionecreateApiKey, revokeApiKey, createWebhook, updateWebhook, deleteWebhook

GET /v1/pricing (getPricing) è pubblico: il prezzo del credito, i piani e i pacchetti, in tempo reale.

Cosa non c'è nel documento #

  • L'endpoint MCP POST /v1/mcp. Vedi Collega Claude.
  • Gli endpoint OAuth per le connessioni Claude (/oauth/*, /.well-known/oauth-*).
  • I socket realtime per canvas e presenza (/v1/realtime/…); si aprono con un ticket di breve durata da createCanvasSession o createProjectPresenceSession.

Cercalo a parole #

find_actions cerca nello stesso catalogo con il linguaggio del set («pick take», «notes», «render»). Puoi usarlo dal tuo Claude senza leggere affatto il documento. Vedi Cosa può fare Claude.

Con Claude

MCP

Il tuo Claude lo fa via MCP, a tuo nome e con il tuo ruolo:

  • find_actions

    Cerca tutto ciò che l'API sa fare e restituisce le azioni corrispondenti con i loro input.

    Chiedi: Trova l'azione che cambia la regola di approvazione di una fase.

Collega Claude 5.1

Questa pagina in Markdown: /docs/it/api/openapi.md