6.0 API6.3 OpenAPIリファレンス
OpenAPIリファレンス
FilmsquareのOpenAPI 3.1ドキュメントの場所、読み方(operation id、x-min-role、タグ)、領域ごとのAPIの一覧です。
APIの完全なリファレンスは、1つのOpenAPI 3.1ドキュメントです。ルート自体から生成されているので、古くなることはありません。
https://app.filmsquare.ai/v1/openapi.json
公開されているので、トークンは不要です。
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を接続するをご覧ください。 - Claudeの接続のためのOAuthエンドポイント(
/oauth/*、/.well-known/oauth-*)。 - キャンバスとプレゼンスのリアルタイムのソケット(
/v1/realtime/…)。createCanvasSessionまたはcreateProjectPresenceSessionで受け取る、短時間有効なチケットで開きます。
言葉で検索する #
find_actionsは、同じカタログを、現場の言葉(「pick take」「notes」「render」)で検索します。ドキュメントを読まなくても、お手持ちのClaudeから使えます。Claudeでできることをご覧ください。
関連ページ #
Claudeでできること
MCPお手持ちのClaudeが、MCPを通じてあなたの名前と役割でこの作業を行います。
find_actionsAPIでできることをすべて検索し、該当するアクションを入力項目つきで返します。
依頼例: 工程のOKのルールを変更するアクションを探して。
Claudeを接続 5.1