---
title: "Referencia OpenAPI"
description: "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."
url: https://www.filmsquare.ai/docs/es/api/openapi/
lang: es
section: api
updated: 2026-11-10
mcp: [find_actions]
---

# Referencia OpenAPI

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.

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

## Leer el documento

| Campo | Significado |
| --- | --- |
| `paths` | Rutas completas, que empiezan por `/v1`. Úsalas con el host `https://app.filmsquare.ai` |
| `operationId` | Un nombre estable por ruta, como `generateForShot`. El mismo nombre es la `action` que tu Claude ejecuta con `run_action` |
| `summary` | Una línea sobre lo que hace la ruta. También es lo que busca `find_actions` |
| `x-min-role` | El 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` |
| `security` | `bearerAuth` (una clave de API `fsk_…` o un token de sesión), o vacío para las rutas públicas |
| `tags` | El área de la API, como `shots`, `takes`, `elements`, `credits` |
| Respuestas de error | Cada 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

| Área | Ejemplos (`operationId`) |
| --- | --- |
| Cuenta y espacios de trabajo | `getMe`, `listWorkspaces`, `createWorkspace`, `listMembers`, `createInvitation`, `setMemberScope` |
| Producciones y estructura | `listProjects`, `createProject`, `createEpisode`, `createScene`, `createShot`, `addShotToEpisode`, `getEpisodeStructure` |
| Guion y desglose | `importScript`, `createScriptRevision`, `submitBreakdown`, `getEpisodeScript`, `listScriptRevisions` |
| Etiquetas del guion | `listScriptTags`, `autoTagScript`, `createScriptTag`, `updateScriptTag`, `archiveScriptTag`, `createElementFromScriptTag` |
| Departamentos y visto bueno | `listProductionSteps`, `updateProductionStep`, `addProductionStep`, `getEpisodeSteps`, `requestSignoff`, `decideSignoff`, `listWaitingOnMe`, `getAnimaticReel` |
| Tomas y generaciones | `estimateShotGeneration`, `generateForShot`, `generateForScene`, `promoteGeneration`, `rerollTake`, `retryGeneration`, `cancelGeneration`, `listGenerations`, `getGeneration`, `selectTake`, `listTools`, `estimateTool`, `applyTool` |
| Elementos | `createElement`, `createQuickElement`, `forkElementVersion`, `generateForElement`, `acceptElementTake`, `searchHandles` |
| Looks de vestuario | `listEpisodeLooks`, `createElementLook`, `updateElementLook`, `archiveElementLook`, `setLookScene` |
| Marcación 3D | `getEpisodeBlocking`, `pushBlockingFrame`, `pushBlockingFrames`, `listPrevisClips`, `addPrevisClips`, `countPrevisClip`, `archivePrevisClip`, `moveTake`, `moveAsset`, `findShotByCode`, `setShotExternalCodes`, `estimateBlockingStill`, `makeBlockingStill` |
| Archivos | `createUploadTicket`, `startMultipartUpload`, `signUploadPart`, `completeMultipartUpload`, `abortMultipartUpload`, `getMultipartUpload`, `completeUpload`, `importFromUrls`, `getAssetVersionUrl`, `getAssetVersionLineage`, `exportEpisodeManifest` |
| Revisión | `listThreads`, `createThread`, `addThreadMessage`, `carryThreadForward`, `getInbox`, `markInboxRead`, `getActivity` |
| Versiones de edición | `listEdits`, `createEdit`, `getEdit`, `addEditVersion` |
| El corte | `getEpisodeCut`, `setCutClipTrim`, `reorderEpisodeCut`, `reviseTake`, `createCutExport`, `listCutExports` |
| Continuidad y enrutado | `getContinuitySheet`, `scanContinuity`, `recordContinuityCheck`, `getModelAcceptance` |
| Carpetas y lienzos | `listFolders`, `createFolder`, `addFolderItems`, `getCanvas`, `applyCanvasOps`, `runCanvasNode` |
| Briefs y makers | `createBrief`, `offerAssignment`, `submitDelivery`, `markAssignmentPaid`, `getMakersOverview` |
| Costos y créditos | `getEpisodeCosts`, `getCredits`, `listCreditEntries`, `getPricing`, `getPlan`, `listInvoices` |
| Integración | `createApiKey`, `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](https://www.filmsquare.ai/docs/es/claude/connect/).
- 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](https://www.filmsquare.ai/docs/es/claude/tools/).

## Relacionado

- [Resumen de la API y claves](https://www.filmsquare.ai/docs/es/api/overview/)
- [Webhooks](https://www.filmsquare.ai/docs/es/api/webhooks/)
