Filmsquare ヘルプドキュメント

6.0 API6.3 OpenAPIリファレンス

OpenAPIリファレンス

FilmsquareのOpenAPI 3.1ドキュメントの場所、読み方(operation id、x-min-role、タグ)、領域ごとのAPIの一覧です。

更新日 2分で読めます.md

このページの内容
  1. ドキュメントの読み方
  2. 領域ごとのAPI
  3. ドキュメントに含まれないもの
  4. 言葉で検索する
  5. 関連ページ

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
securitybearerAuth(APIキーfsk_…またはセッショントークン)。公開ルートは空
tagsAPIの領域。たとえば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
部署とOKlistProductionSteps, 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_actions

    APIでできることをすべて検索し、該当するアクションを入力項目つきで返します。

    依頼例: 工程のOKのルールを変更するアクションを探して。

Claudeを接続 5.1

このページのMarkdown: /docs/ja/api/openapi.md