Filmsquare BantuanPanduan

6.0 API6.3 Referensi OpenAPI

Referensi OpenAPI

Di mana dokumen OpenAPI 3.1 Filmsquare berada, cara membacanya (operation id, x-min-role, tag), dan peta API per area.

Diperbarui 2 menit baca.md

Di halaman ini
  1. Membaca dokumennya
  2. API per area
  3. Yang tidak ada di dokumen
  4. Cari dengan kata-kata
  5. Terkait

Referensi lengkap API adalah satu dokumen OpenAPI 3.1, dihasilkan dari rute itu sendiri, jadi tidak pernah usang:

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

Dokumen ini publik: tidak butuh token.

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

Membaca dokumennya #

FieldArtinya
pathsPath lengkap, dimulai dengan /v1. Pakai dengan host https://app.filmsquare.ai
operationIdNama stabil per rute, seperti generateForShot. Nama yang sama adalah action yang dijalankan Claude Anda dengan run_action
summarySatu baris tentang fungsi rute. Ini juga yang dicari find_actions
x-min-rolePeran ruang kerja terendah yang boleh memanggilnya: viewer … owner, authenticated (pemanggil yang sudah masuk, tanpa ruang kerja) atau public
securitybearerAuth (kunci API fsk_… atau token sesi), atau kosong untuk rute publik
tagsArea API, seperti shots, takes, elements, credits
Respons errorSetiap rute mencantumkan skema Error bersama: {"error": {"code", "message", "details"}}

Impor di alat OpenAPI apa pun (Postman, Insomnia, Bruno) atau buat klien bertipe darinya, misalnya dengan openapi-typescript.

API per area #

AreaContoh (operationId)
Akun dan ruang kerjagetMe, listWorkspaces, createWorkspace, listMembers, createInvitation, setMemberScope
Produksi dan strukturlistProjects, createProject, createEpisode, createScene, createShot, addShotToEpisode, getEpisodeStructure
Skenario dan breakdownimportScript, createScriptRevision, submitBreakdown, getEpisodeScript, listScriptRevisions
Tag skenariolistScriptTags, autoTagScript, createScriptTag, updateScriptTag, archiveScriptTag, createElementFromScriptTag
Departemen dan persetujuanlistProductionSteps, updateProductionStep, addProductionStep, getEpisodeSteps, requestSignoff, decideSignoff, listWaitingOnMe, getAnimaticReel
Take dan generateestimateShotGeneration, generateForShot, generateForScene, promoteGeneration, rerollTake, retryGeneration, cancelGeneration, listGenerations, getGeneration, selectTake, listTools, estimateTool, applyTool
ElemencreateElement, createQuickElement, forkElementVersion, generateForElement, acceptElementTake, searchHandles
Look kostumlistEpisodeLooks, createElementLook, updateElementLook, archiveElementLook, setLookScene
Blocking 3DgetEpisodeBlocking, pushBlockingFrame, pushBlockingFrames, listPrevisClips, addPrevisClips, countPrevisClip, archivePrevisClip, moveTake, moveAsset, findShotByCode, setShotExternalCodes, estimateBlockingStill, makeBlockingStill
FilecreateUploadTicket, startMultipartUpload, signUploadPart, completeMultipartUpload, abortMultipartUpload, getMultipartUpload, completeUpload, importFromUrls, getAssetVersionUrl, getAssetVersionLineage, exportEpisodeManifest
PeninjauanlistThreads, createThread, addThreadMessage, carryThreadForward, getInbox, markInboxRead, getActivity
EditanlistEdits, createEdit, getEdit, addEditVersion
CutgetEpisodeCut, setCutClipTrim, reorderEpisodeCut, reviseTake, createCutExport, listCutExports
Kontinuitas dan routinggetContinuitySheet, scanContinuity, recordContinuityCheck, getModelAcceptance
Folder dan kanvaslistFolders, createFolder, addFolderItems, getCanvas, applyCanvasOps, runCanvasNode
Brief dan pembuatcreateBrief, offerAssignment, submitDelivery, markAssignmentPaid, getMakersOverview
Biaya dan kreditgetEpisodeCosts, getCredits, listCreditEntries, getPricing, getPlan, listInvoices
IntegrasicreateApiKey, revokeApiKey, createWebhook, updateWebhook, deleteWebhook

GET /v1/pricing (getPricing) bersifat publik: harga kredit, paket, dan bundel, langsung.

Yang tidak ada di dokumen #

  • Endpoint MCP POST /v1/mcp. Lihat Hubungkan Claude.
  • Endpoint OAuth untuk koneksi Claude (/oauth/*, /.well-known/oauth-*).
  • Socket realtime untuk kanvas dan presence (/v1/realtime/…); dibuka dengan tiket berumur pendek dari createCanvasSession atau createProjectPresenceSession.

Cari dengan kata-kata #

find_actions mencari katalog yang sama dengan bahasa set ("pick take", "notes", "render"). Anda bisa memakainya dari Claude Anda sendiri tanpa membaca dokumennya sama sekali. Lihat Apa yang bisa dikerjakan Claude.

Dengan Claude

MCP

Claude Anda sendiri mengerjakan ini lewat MCP, atas nama Anda dan dengan peran Anda:

  • find_actions

    Mencari semua yang bisa dilakukan API dan mengembalikan aksi yang cocok beserta inputnya.

    Tanya: Cari aksi yang mengubah aturan persetujuan sebuah tahap.

Hubungkan Claude 5.1

Halaman ini sebagai Markdown: /docs/id/api/openapi.md