Filmsquare AjudaDocumentação

6.0 API6.3 Referência OpenAPI

Referência OpenAPI

Onde fica o documento OpenAPI 3.1 do Filmsquare, como lê-lo (operation ids, x-min-role, tags) e um mapa da API por área.

Atualizado em 3 min de leitura.md

Nesta página
  1. Ler o documento
  2. A API por área
  3. O que não está no documento
  4. Busque em palavras
  5. Relacionados

A referência completa da API é um só documento OpenAPI 3.1, gerado das próprias rotas, então nunca fica desatualizado:

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

Ele é público: não precisa de token.

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

Ler o documento #

CampoSignificado
pathsCaminhos completos, começando com /v1. Use-os com o host https://app.filmsquare.ai
operationIdUm nome estável por rota, como generateForShot. O mesmo nome é a action que o seu Claude executa com run_action
summaryUma linha sobre o que a rota faz. É também o que o find_actions busca
x-min-roleA função mais baixa do espaço de trabalho que pode chamá-la: viewer … owner, authenticated (qualquer chamador conectado, sem espaço de trabalho) ou public
securitybearerAuth (uma chave de API fsk_… ou um token de sessão), ou vazio para rotas públicas
tagsA área da API, como shots, takes, elements, credits
Respostas de erroToda rota lista o schema compartilhado Error: {"error": {"code", "message", "details"}}

Importe-o em qualquer ferramenta OpenAPI (Postman, Insomnia, Bruno) ou gere um cliente tipado a partir dele, por exemplo com openapi-typescript.

A API por área #

ÁreaExemplos (operationId)
Conta e espaços de trabalhogetMe, listWorkspaces, createWorkspace, listMembers, createInvitation, setMemberScope
Produções e estruturalistProjects, createProject, createEpisode, createScene, createShot, addShotToEpisode, getEpisodeStructure
Roteiro e decupagemimportScript, createScriptRevision, submitBreakdown, getEpisodeScript, listScriptRevisions
Marcações do roteirolistScriptTags, autoTagScript, createScriptTag, updateScriptTag, archiveScriptTag, createElementFromScriptTag
Departamentos e aprovaçãolistProductionSteps, updateProductionStep, addProductionStep, getEpisodeSteps, requestSignoff, decideSignoff, listWaitingOnMe, getAnimaticReel
Takes e geraçõesestimateShotGeneration, generateForShot, generateForScene, promoteGeneration, rerollTake, retryGeneration, cancelGeneration, listGenerations, getGeneration, selectTake, listTools, estimateTool, applyTool
ElementoscreateElement, createQuickElement, forkElementVersion, generateForElement, acceptElementTake, searchHandles
Looks de figurinolistEpisodeLooks, createElementLook, updateElementLook, archiveElementLook, setLookScene
Marcação em 3DgetEpisodeBlocking, pushBlockingFrame, pushBlockingFrames, listPrevisClips, addPrevisClips, countPrevisClip, archivePrevisClip, moveTake, moveAsset, findShotByCode, setShotExternalCodes, estimateBlockingStill, makeBlockingStill
ArquivoscreateUploadTicket, startMultipartUpload, signUploadPart, completeMultipartUpload, abortMultipartUpload, getMultipartUpload, completeUpload, importFromUrls, getAssetVersionUrl, getAssetVersionLineage, exportEpisodeManifest
RevisãolistThreads, createThread, addThreadMessage, carryThreadForward, getInbox, markInboxRead, getActivity
MontagenslistEdits, createEdit, getEdit, addEditVersion
O cortegetEpisodeCut, setCutClipTrim, reorderEpisodeCut, reviseTake, createCutExport, listCutExports
Continuidade e roteamentogetContinuitySheet, scanContinuity, recordContinuityCheck, getModelAcceptance
Pastas e canvaseslistFolders, createFolder, addFolderItems, getCanvas, applyCanvasOps, runCanvasNode
Briefings e artistascreateBrief, offerAssignment, submitDelivery, markAssignmentPaid, getMakersOverview
Custos e créditosgetEpisodeCosts, getCredits, listCreditEntries, getPricing, getPlan, listInvoices
IntegraçãocreateApiKey, revokeApiKey, createWebhook, updateWebhook, deleteWebhook

GET /v1/pricing (getPricing) é público: o preço do crédito, as assinaturas e os pacotes, ao vivo.

O que não está no documento #

  • O endpoint MCP POST /v1/mcp. Veja Conectar o Claude.
  • Os endpoints OAuth das conexões do Claude (/oauth/*, /.well-known/oauth-*).
  • Os sockets em tempo real de canvases e presença (/v1/realtime/…); eles abrem com um ticket de curta duração de createCanvasSession ou createProjectPresenceSession.

Busque em palavras #

find_actions busca o mesmo catálogo em linguagem de set ("pick take", "notes", "render"). Você pode usá-lo pelo seu próprio Claude sem ler o documento. Veja O que o Claude faz.

Com o Claude

MCP

O seu próprio Claude faz isso via MCP, em seu nome e com a sua função:

  • find_actions

    Busca tudo o que a API faz e devolve as ações que combinam, com seus parâmetros.

    Peça: Ache a ação que muda a regra de aprovação de uma etapa.

Conectar o Claude 5.1

Esta página em Markdown: /docs/pt-br/api/openapi.md