---
title: "Referensi OpenAPI"
description: "Di mana dokumen OpenAPI 3.1 Filmsquare berada, cara membacanya (operation id, x-min-role, tag), dan peta API per area."
url: https://www.filmsquare.ai/docs/id/api/openapi/
lang: id
section: api
updated: 2026-11-10
mcp: [find_actions]
---

# Referensi OpenAPI

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.

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

## Membaca dokumennya

| Field | Artinya |
| --- | --- |
| `paths` | Path lengkap, dimulai dengan `/v1`. Pakai dengan host `https://app.filmsquare.ai` |
| `operationId` | Nama stabil per rute, seperti `generateForShot`. Nama yang sama adalah `action` yang dijalankan Claude Anda dengan `run_action` |
| `summary` | Satu baris tentang fungsi rute. Ini juga yang dicari `find_actions` |
| `x-min-role` | Peran ruang kerja terendah yang boleh memanggilnya: `viewer` … `owner`, `authenticated` (pemanggil yang sudah masuk, tanpa ruang kerja) atau `public` |
| `security` | `bearerAuth` (kunci API `fsk_…` atau token sesi), atau kosong untuk rute publik |
| `tags` | Area API, seperti `shots`, `takes`, `elements`, `credits` |
| Respons error | Setiap 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

| Area | Contoh (`operationId`) |
| --- | --- |
| Akun dan ruang kerja | `getMe`, `listWorkspaces`, `createWorkspace`, `listMembers`, `createInvitation`, `setMemberScope` |
| Produksi dan struktur | `listProjects`, `createProject`, `createEpisode`, `createScene`, `createShot`, `addShotToEpisode`, `getEpisodeStructure` |
| Skenario dan breakdown | `importScript`, `createScriptRevision`, `submitBreakdown`, `getEpisodeScript`, `listScriptRevisions` |
| Tag skenario | `listScriptTags`, `autoTagScript`, `createScriptTag`, `updateScriptTag`, `archiveScriptTag`, `createElementFromScriptTag` |
| Departemen dan persetujuan | `listProductionSteps`, `updateProductionStep`, `addProductionStep`, `getEpisodeSteps`, `requestSignoff`, `decideSignoff`, `listWaitingOnMe`, `getAnimaticReel` |
| Take dan generate | `estimateShotGeneration`, `generateForShot`, `generateForScene`, `promoteGeneration`, `rerollTake`, `retryGeneration`, `cancelGeneration`, `listGenerations`, `getGeneration`, `selectTake`, `listTools`, `estimateTool`, `applyTool` |
| Elemen | `createElement`, `createQuickElement`, `forkElementVersion`, `generateForElement`, `acceptElementTake`, `searchHandles` |
| Look kostum | `listEpisodeLooks`, `createElementLook`, `updateElementLook`, `archiveElementLook`, `setLookScene` |
| Blocking 3D | `getEpisodeBlocking`, `pushBlockingFrame`, `pushBlockingFrames`, `listPrevisClips`, `addPrevisClips`, `countPrevisClip`, `archivePrevisClip`, `moveTake`, `moveAsset`, `findShotByCode`, `setShotExternalCodes`, `estimateBlockingStill`, `makeBlockingStill` |
| File | `createUploadTicket`, `startMultipartUpload`, `signUploadPart`, `completeMultipartUpload`, `abortMultipartUpload`, `getMultipartUpload`, `completeUpload`, `importFromUrls`, `getAssetVersionUrl`, `getAssetVersionLineage`, `exportEpisodeManifest` |
| Peninjauan | `listThreads`, `createThread`, `addThreadMessage`, `carryThreadForward`, `getInbox`, `markInboxRead`, `getActivity` |
| Editan | `listEdits`, `createEdit`, `getEdit`, `addEditVersion` |
| Cut | `getEpisodeCut`, `setCutClipTrim`, `reorderEpisodeCut`, `reviseTake`, `createCutExport`, `listCutExports` |
| Kontinuitas dan routing | `getContinuitySheet`, `scanContinuity`, `recordContinuityCheck`, `getModelAcceptance` |
| Folder dan kanvas | `listFolders`, `createFolder`, `addFolderItems`, `getCanvas`, `applyCanvasOps`, `runCanvasNode` |
| Brief dan pembuat | `createBrief`, `offerAssignment`, `submitDelivery`, `markAssignmentPaid`, `getMakersOverview` |
| Biaya dan kredit | `getEpisodeCosts`, `getCredits`, `listCreditEntries`, `getPricing`, `getPlan`, `listInvoices` |
| Integrasi | `createApiKey`, `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](https://www.filmsquare.ai/docs/id/claude/connect/).
- 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](https://www.filmsquare.ai/docs/id/claude/tools/).

## Terkait

- [Ikhtisar API dan kunci](https://www.filmsquare.ai/docs/id/api/overview/)
- [Webhook](https://www.filmsquare.ai/docs/id/api/webhooks/)
