Filmsquare AyudaDocumentación

6.0 API6.3 Referencia OpenAPI

Referencia OpenAPI

Dónde está el documento OpenAPI 3.1 de Filmsquare, cómo leerlo (operation ids, x-min-role, tags) y un mapa de la API por áreas.

Actualizado 3 min de lectura.md

En esta página
  1. Leer el documento
  2. La API por áreas
  3. Lo que no está en el documento
  4. Búscalo con palabras
  5. Relacionado

La referencia completa de la API es un único documento OpenAPI 3.1, generado a partir de las propias rutas, así que nunca está desactualizado:

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

Es público: no hace falta token.

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

Leer el documento #

CampoSignificado
pathsRutas completas, que empiezan por /v1. Úsalas con el host https://app.filmsquare.ai
operationIdUn nombre estable por ruta, como generateForShot. El mismo nombre es la action que tu Claude ejecuta con run_action
summaryUna línea sobre lo que hace la ruta. También es lo que busca find_actions
x-min-roleEl rol de espacio de trabajo más bajo que puede llamarla: viewer … owner, authenticated (cualquier llamada con sesión iniciada, sin espacio de trabajo) o public
securitybearerAuth (una clave de API fsk_… o un token de sesión), o vacío para las rutas públicas
tagsEl área de la API, como shots, takes, elements, credits
Respuestas de errorCada ruta lista el esquema compartido Error: {"error": {"code", "message", "details"}}

Impórtalo en cualquier herramienta OpenAPI (Postman, Insomnia, Bruno) o genera un cliente tipado a partir de él, por ejemplo con openapi-typescript.

La API por áreas #

ÁreaEjemplos (operationId)
Cuenta y espacios de trabajogetMe, listWorkspaces, createWorkspace, listMembers, createInvitation, setMemberScope
Producciones y estructuralistProjects, createProject, createEpisode, createScene, createShot, addShotToEpisode, getEpisodeStructure
Guion y desgloseimportScript, createScriptRevision, submitBreakdown, getEpisodeScript, listScriptRevisions
Etiquetas del guionlistScriptTags, autoTagScript, createScriptTag, updateScriptTag, archiveScriptTag, createElementFromScriptTag
Departamentos y visto buenolistProductionSteps, updateProductionStep, addProductionStep, getEpisodeSteps, requestSignoff, decideSignoff, listWaitingOnMe, getAnimaticReel
Tomas y generacionesestimateShotGeneration, generateForShot, generateForScene, promoteGeneration, rerollTake, retryGeneration, cancelGeneration, listGenerations, getGeneration, selectTake, listTools, estimateTool, applyTool
ElementoscreateElement, createQuickElement, forkElementVersion, generateForElement, acceptElementTake, searchHandles
Looks de vestuariolistEpisodeLooks, createElementLook, updateElementLook, archiveElementLook, setLookScene
Marcación 3DgetEpisodeBlocking, pushBlockingFrame, pushBlockingFrames, listPrevisClips, addPrevisClips, countPrevisClip, archivePrevisClip, moveTake, moveAsset, findShotByCode, setShotExternalCodes, estimateBlockingStill, makeBlockingStill
ArchivoscreateUploadTicket, startMultipartUpload, signUploadPart, completeMultipartUpload, abortMultipartUpload, getMultipartUpload, completeUpload, importFromUrls, getAssetVersionUrl, getAssetVersionLineage, exportEpisodeManifest
RevisiónlistThreads, createThread, addThreadMessage, carryThreadForward, getInbox, markInboxRead, getActivity
Versiones de ediciónlistEdits, createEdit, getEdit, addEditVersion
El cortegetEpisodeCut, setCutClipTrim, reorderEpisodeCut, reviseTake, createCutExport, listCutExports
Continuidad y enrutadogetContinuitySheet, scanContinuity, recordContinuityCheck, getModelAcceptance
Carpetas y lienzoslistFolders, createFolder, addFolderItems, getCanvas, applyCanvasOps, runCanvasNode
Briefs y makerscreateBrief, offerAssignment, submitDelivery, markAssignmentPaid, getMakersOverview
Costos y créditosgetEpisodeCosts, getCredits, listCreditEntries, getPricing, getPlan, listInvoices
IntegracióncreateApiKey, revokeApiKey, createWebhook, updateWebhook, deleteWebhook

GET /v1/pricing (getPricing) es público: el precio del crédito, los planes y los paquetes, en directo.

Lo que no está en el documento #

  • El endpoint MCP POST /v1/mcp. Consulta Conecta Claude.
  • Los endpoints OAuth de las conexiones de Claude (/oauth/*, /.well-known/oauth-*).
  • Los sockets en tiempo real de lienzos y presencia (/v1/realtime/…); se abren con un ticket de corta duración de createCanvasSession o createProjectPresenceSession.

Búscalo con palabras #

find_actions busca en el mismo catálogo con el lenguaje del set ("pick take", "notes", "render"). Puedes usarlo desde tu propio Claude sin leer el documento en absoluto. Consulta Qué puede hacer Claude.

Con Claude

MCP

Tu propio Claude lo hace por MCP, en tu nombre y con tu rol:

  • find_actions

    Busca en todo lo que puede hacer la API y devuelve las acciones que encajan, con sus datos de entrada.

    Pide: Busca la acción que cambia la regla de visto bueno de un paso.

Conectar Claude 5.1

Esta página en Markdown: /docs/es/api/openapi.md