Filmsquare YardımDokümanlar

6.0 API6.3 OpenAPI başvurusu

OpenAPI başvurusu

Filmsquare OpenAPI 3.1 belgesi nerede, nasıl okunur (operation id'ler, x-min-role, etiketler) ve API'nin alan alan haritası.

Güncellendi 2 dk okuma.md

Bu sayfada
  1. Belgeyi okumak
  2. API alan alan
  3. Belgede olmayanlar
  4. Kelimelerle ara
  5. İlgili

API'nin tam başvurusu, rotaların kendisinden üretilen tek bir OpenAPI 3.1 belgesidir, yani hiçbir zaman eskimez:

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

Herkese açıktır: token gerekmez.

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

Belgeyi okumak #

AlanAnlamı
paths/v1 ile başlayan tam yollar. https://app.filmsquare.ai host'uyla kullan
operationIdRota başına kararlı bir ad, örneğin generateForShot. Aynı ad, Claude'unun run_action ile çalıştırdığı action'dır
summaryRotanın ne yaptığına dair tek satır. find_actions'ın aradığı da budur
x-min-roleOnu çağırabilen en düşük çalışma alanı rolü: viewer … owner, authenticated (giriş yapmış herhangi bir çağıran, çalışma alanı yok) ya da public
securitybearerAuth (bir fsk_… API anahtarı ya da bir oturum token'ı), herkese açık rotalar için boş
tagsAPI'nin alanı, örneğin shots, takes, elements, credits
Hata yanıtlarıHer rota ortak Error şemasını listeler: {"error": {"code", "message", "details"}}

Onu herhangi bir OpenAPI aracında (Postman, Insomnia, Bruno) içe aktar ya da ondan tipli bir istemci üret, örneğin openapi-typescript ile.

API alan alan #

AlanÖrnekler (operationId)
Hesap ve çalışma alanlarıgetMe, listWorkspaces, createWorkspace, listMembers, createInvitation, setMemberScope
Yapımlar ve yapılistProjects, createProject, createEpisode, createScene, createShot, addShotToEpisode, getEpisodeStructure
Senaryo ve dökümimportScript, createScriptRevision, submitBreakdown, getEpisodeScript, listScriptRevisions
Senaryo etiketlerilistScriptTags, autoTagScript, createScriptTag, updateScriptTag, archiveScriptTag, createElementFromScriptTag
Departmanlar ve onaylistProductionSteps, updateProductionStep, addProductionStep, getEpisodeSteps, requestSignoff, decideSignoff, listWaitingOnMe, getAnimaticReel
Çekimler ve üretimlerestimateShotGeneration, generateForShot, generateForScene, promoteGeneration, rerollTake, retryGeneration, cancelGeneration, listGenerations, getGeneration, selectTake, listTools, estimateTool, applyTool
ÖğelercreateElement, createQuickElement, forkElementVersion, generateForElement, acceptElementTake, searchHandles
Kostüm görünümlerilistEpisodeLooks, createElementLook, updateElementLook, archiveElementLook, setLookScene
3D mizansengetEpisodeBlocking, pushBlockingFrame, pushBlockingFrames, listPrevisClips, addPrevisClips, countPrevisClip, archivePrevisClip, moveTake, moveAsset, findShotByCode, setShotExternalCodes, estimateBlockingStill, makeBlockingStill
DosyalarcreateUploadTicket, startMultipartUpload, signUploadPart, completeMultipartUpload, abortMultipartUpload, getMultipartUpload, completeUpload, importFromUrls, getAssetVersionUrl, getAssetVersionLineage, exportEpisodeManifest
Gözden geçirmelistThreads, createThread, addThreadMessage, carryThreadForward, getInbox, markInboxRead, getActivity
Kurgu versiyonlarılistEdits, createEdit, getEdit, addEditVersion
KurgugetEpisodeCut, setCutClipTrim, reorderEpisodeCut, reviseTake, createCutExport, listCutExports
Devamlılık ve yönlendirmegetContinuitySheet, scanContinuity, recordContinuityCheck, getModelAcceptance
Klasörler ve tuvallerlistFolders, createFolder, addFolderItems, getCanvas, applyCanvasOps, runCanvasNode
Brifler ve üreticilercreateBrief, offerAssignment, submitDelivery, markAssignmentPaid, getMakersOverview
Maliyetler ve kredilergetEpisodeCosts, getCredits, listCreditEntries, getPricing, getPlan, listInvoices
EntegrasyoncreateApiKey, revokeApiKey, createWebhook, updateWebhook, deleteWebhook

GET /v1/pricing (getPricing) herkese açıktır: kredi fiyatı, abonelikler ve paketler, canlı.

Belgede olmayanlar #

  • MCP uç noktası POST /v1/mcp. Bkz. Claude'u bağla.
  • Claude bağlantıları için OAuth uç noktaları (/oauth/*, /.well-known/oauth-*).
  • Tuvaller ve varlık için gerçek zamanlı soketler (/v1/realtime/…); createCanvasSession ya da createProjectPresenceSession'dan alınan kısa ömürlü bir biletle açılırlar.

Kelimelerle ara #

find_actions aynı kataloğu set dilinde arar ("pick take", "notes", "render"). Belgeyi hiç okumadan kendi Claude'undan kullanabilirsin. Bkz. Claude neler yapabilir.

Claude ile

MCP

Kendi Claude'un bunu MCP üzerinden, senin adınla ve senin rolünle yapar:

  • find_actions

    API'nin yapabildiği her şeyi arar ve eşleşen eylemleri girdileriyle döndürür.

    Şunu iste: Bir adımın onay kuralını değiştiren eylemi bul.

Claude'u bağla 5.1

Bu sayfa Markdown olarak: /docs/tr/api/openapi.md