---
title: "OpenAPIリファレンス"
description: "FilmsquareのOpenAPI 3.1ドキュメントの場所、読み方（operation id、x-min-role、タグ）、領域ごとのAPIの一覧です。"
url: https://www.filmsquare.ai/docs/ja/api/openapi/
lang: ja
section: api
updated: 2026-11-10
mcp: [find_actions]
---

# OpenAPIリファレンス

APIの完全なリファレンスは、1つのOpenAPI 3.1ドキュメントです。ルート自体から生成されているので、古くなることはありません。

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

公開されているので、トークンは不要です。

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

## ドキュメントの読み方

| フィールド | 意味 |
| --- | --- |
| `paths` | `/v1`で始まる完全なパス。ホスト`https://app.filmsquare.ai`と組み合わせて使います |
| `operationId` | ルートごとの固定の名前。たとえば`generateForShot`です。同じ名前が、お手持ちのClaudeが`run_action`で実行する`action`です |
| `summary` | ルートの内容を説明する一行。`find_actions`が検索する対象でもあります |
| `x-min-role` | 呼び出せる最低のワークスペースの役割：`viewer`〜`owner`、`authenticated`（ログイン済みなら誰でも、ワークスペースなし）、または`public` |
| `security` | `bearerAuth`（APIキー`fsk_…`またはセッショントークン）。公開ルートは空 |
| `tags` | APIの領域。たとえば`shots`、`takes`、`elements`、`credits` |
| エラーレスポンス | どのルートも、共通の`Error`スキーマを示します：`{"error": {"code", "message", "details"}}` |

Postman、Insomnia、BrunoなどのOpenAPIツールに取り込んだり、`openapi-typescript`などで型つきのクライアントを生成したりできます。

## 領域ごとのAPI

| 領域 | 例（`operationId`） |
| --- | --- |
| アカウントとワークスペース | `getMe`, `listWorkspaces`, `createWorkspace`, `listMembers`, `createInvitation`, `setMemberScope` |
| 作品と構成 | `listProjects`, `createProject`, `createEpisode`, `createScene`, `createShot`, `addShotToEpisode`, `getEpisodeStructure` |
| 脚本とカット割り | `importScript`, `createScriptRevision`, `submitBreakdown`, `getEpisodeScript`, `listScriptRevisions` |
| 脚本のタグ | `listScriptTags`, `autoTagScript`, `createScriptTag`, `updateScriptTag`, `archiveScriptTag`, `createElementFromScriptTag` |
| 部署とOK | `listProductionSteps`, `updateProductionStep`, `addProductionStep`, `getEpisodeSteps`, `requestSignoff`, `decideSignoff`, `listWaitingOnMe`, `getAnimaticReel` |
| テイクと生成 | `estimateShotGeneration`, `generateForShot`, `generateForScene`, `promoteGeneration`, `rerollTake`, `retryGeneration`, `cancelGeneration`, `listGenerations`, `getGeneration`, `selectTake`, `listTools`, `estimateTool`, `applyTool` |
| アセット | `createElement`, `createQuickElement`, `forkElementVersion`, `generateForElement`, `acceptElementTake`, `searchHandles` |
| 衣装のスタイリング | `listEpisodeLooks`, `createElementLook`, `updateElementLook`, `archiveElementLook`, `setLookScene` |
| 3Dブロッキング | `getEpisodeBlocking`, `pushBlockingFrame`, `pushBlockingFrames`, `listPrevisClips`, `addPrevisClips`, `countPrevisClip`, `archivePrevisClip`, `moveTake`, `moveAsset`, `findShotByCode`, `setShotExternalCodes`, `estimateBlockingStill`, `makeBlockingStill` |
| ファイル | `createUploadTicket`, `startMultipartUpload`, `signUploadPart`, `completeMultipartUpload`, `abortMultipartUpload`, `getMultipartUpload`, `completeUpload`, `importFromUrls`, `getAssetVersionUrl`, `getAssetVersionLineage`, `exportEpisodeManifest` |
| レビュー | `listThreads`, `createThread`, `addThreadMessage`, `carryThreadForward`, `getInbox`, `markInboxRead`, `getActivity` |
| 編集版 | `listEdits`, `createEdit`, `getEdit`, `addEditVersion` |
| 編集 | `getEpisodeCut`, `setCutClipTrim`, `reorderEpisodeCut`, `reviseTake`, `createCutExport`, `listCutExports` |
| つながりとルーティング | `getContinuitySheet`, `scanContinuity`, `recordContinuityCheck`, `getModelAcceptance` |
| フォルダとキャンバス | `listFolders`, `createFolder`, `addFolderItems`, `getCanvas`, `applyCanvasOps`, `runCanvasNode` |
| 指示書とクリエイター | `createBrief`, `offerAssignment`, `submitDelivery`, `markAssignmentPaid`, `getMakersOverview` |
| 費用とクレジット | `getEpisodeCosts`, `getCredits`, `listCreditEntries`, `getPricing`, `getPlan`, `listInvoices` |
| 連携 | `createApiKey`, `revokeApiKey`, `createWebhook`, `updateWebhook`, `deleteWebhook` |

`GET /v1/pricing`（`getPricing`）は公開されていて、クレジットの価格、プラン、クレジットパックを、最新の状態で返します。

## ドキュメントに含まれないもの

- MCPのエンドポイント`POST /v1/mcp`。[Claudeを接続する](https://www.filmsquare.ai/docs/ja/claude/connect/)をご覧ください。
- Claudeの接続のためのOAuthエンドポイント（`/oauth/*`、`/.well-known/oauth-*`）。
- キャンバスとプレゼンスのリアルタイムのソケット（`/v1/realtime/…`）。`createCanvasSession`または`createProjectPresenceSession`で受け取る、短時間有効なチケットで開きます。

## 言葉で検索する

`find_actions`は、同じカタログを、現場の言葉（「pick take」「notes」「render」）で検索します。ドキュメントを読まなくても、お手持ちのClaudeから使えます。[Claudeでできること](https://www.filmsquare.ai/docs/ja/claude/tools/)をご覧ください。

## 関連ページ

- [APIの概要とキー](https://www.filmsquare.ai/docs/ja/api/overview/)
- [Webhook](https://www.filmsquare.ai/docs/ja/api/webhooks/)
