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ı.
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 #
| Alan | Anlamı |
|---|---|
paths | /v1 ile başlayan tam yollar. https://app.filmsquare.ai host'uyla kullan |
operationId | Rota başına kararlı bir ad, örneğin generateForShot. Aynı ad, Claude'unun run_action ile çalıştırdığı action'dır |
summary | Rotanın ne yaptığına dair tek satır. find_actions'ın aradığı da budur |
x-min-role | Onu ç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 |
security | bearerAuth (bir fsk_… API anahtarı ya da bir oturum token'ı), herkese açık rotalar için boş |
tags | API'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üm | importScript, createScriptRevision, submitBreakdown, getEpisodeScript, listScriptRevisions |
| Senaryo etiketleri | listScriptTags, autoTagScript, createScriptTag, updateScriptTag, archiveScriptTag, createElementFromScriptTag |
| Departmanlar ve onay | listProductionSteps, updateProductionStep, addProductionStep, getEpisodeSteps, requestSignoff, decideSignoff, listWaitingOnMe, getAnimaticReel |
| Çekimler ve üretimler | estimateShotGeneration, generateForShot, generateForScene, promoteGeneration, rerollTake, retryGeneration, cancelGeneration, listGenerations, getGeneration, selectTake, listTools, estimateTool, applyTool |
| Öğeler | createElement, createQuickElement, forkElementVersion, generateForElement, acceptElementTake, searchHandles |
| Kostüm görünümleri | listEpisodeLooks, createElementLook, updateElementLook, archiveElementLook, setLookScene |
| 3D mizansen | getEpisodeBlocking, pushBlockingFrame, pushBlockingFrames, listPrevisClips, addPrevisClips, countPrevisClip, archivePrevisClip, moveTake, moveAsset, findShotByCode, setShotExternalCodes, estimateBlockingStill, makeBlockingStill |
| Dosyalar | createUploadTicket, startMultipartUpload, signUploadPart, completeMultipartUpload, abortMultipartUpload, getMultipartUpload, completeUpload, importFromUrls, getAssetVersionUrl, getAssetVersionLineage, exportEpisodeManifest |
| Gözden geçirme | listThreads, createThread, addThreadMessage, carryThreadForward, getInbox, markInboxRead, getActivity |
| Kurgu versiyonları | listEdits, createEdit, getEdit, addEditVersion |
| Kurgu | getEpisodeCut, setCutClipTrim, reorderEpisodeCut, reviseTake, createCutExport, listCutExports |
| Devamlılık ve yönlendirme | getContinuitySheet, scanContinuity, recordContinuityCheck, getModelAcceptance |
| Klasörler ve tuvaller | listFolders, createFolder, addFolderItems, getCanvas, applyCanvasOps, runCanvasNode |
| Brifler ve üreticiler | createBrief, offerAssignment, submitDelivery, markAssignmentPaid, getMakersOverview |
| Maliyetler ve krediler | getEpisodeCosts, getCredits, listCreditEntries, getPricing, getPlan, listInvoices |
| Entegrasyon | createApiKey, 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/…);createCanvasSessionya dacreateProjectPresenceSession'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.
İlgili #
Claude ile
MCPKendi Claude'un bunu MCP üzerinden, senin adınla ve senin rolünle yapar:
find_actionsAPI'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