Quickstart

• A Filmo account whose environment has the API and MCP switched on by Filmo; an administrator of the account cannot switch it on. The API and MCP are included in any paid plan and are not an add-on, and a free trial (14 days, no card) can create keys too.
• An administrator of the account to create the key. If that is not you, read the next section first.
• The add-ons for the resources you plan to use. A free trial unlocks all of them, and when it ends the endpoints behind an add-on answer 402 addon_required.
• For the examples: cURL, Windows PowerShell 5.1 or later, Node 22 or later, or Python 3 with requests.

The base URL is https://app.filmo.io/api/v1. Plans and add-ons explains what each add-on opens.

Only an administrator can create a key, and the key acts as that person (Permissions). Ask an administrator for a key and tell them:

• The exact scopes your integration needs. Always include account:read: the first call needs it, and without it you get 403 insufficient_scope.
• To name the key after the integration, so it can be found and revoked later.
• To send you the key through a shared secrets manager, never by email or chat. It is shown once and gives programmatic access to the company's data.

Who owns a key and what happens when that person leaves is explained in Authentication.

1. 1

   Open the API and MCP settings

   In the Filmo app, as an administrator, open the section of the settings for the API and MCP. In the Spanish interface it reads Ajustes → API y MCP.

2. 2

   Add a key

   Give it a name that says what it is for and choose its scopes. Include account:read, and add only what the integration needs. Set an expiry date if the form offers one and you rotate keys on a schedule; a key without a date never expires.

3. 3

   Copy the key now

   The key starts with fk_live_ and is shown only once; Filmo keeps only a hash of it. Store it in a secrets manager or an environment variable, not in your code or your repository.

For the same steps without the API vocabulary, see Generate an API key in the help center.

Set the key in an environment variable and call GET /api/v1/account. The examples read FILMO_API_KEY and, if set, FILMO_BASE_URL; the default base URL is https://app.filmo.io.

# Paste the key when asked; it stays out of your shell history. Works in bash and zsh.
printf 'Filmo API key: '; stty -echo; read -r FILMO_API_KEY; stty echo; echo; export FILMO_API_KEY

FILMO_BASE_URL="${FILMO_BASE_URL:-https://app.filmo.io}"

curl -sS "$FILMO_BASE_URL/api/v1/account" \
  -H "Authorization: Bearer $FILMO_API_KEY" \
  -H "Accept-Language: en-US"

# Windows PowerShell 5.1 and PowerShell 7. Paste the key when asked.
$secure = Read-Host "Filmo API key" -AsSecureString
$env:FILMO_API_KEY = [System.Net.NetworkCredential]::new("", $secure).Password
$base = if ($env:FILMO_BASE_URL) { $env:FILMO_BASE_URL } else { "https://app.filmo.io" }

try {
  $response = Invoke-RestMethod -Uri "$base/api/v1/account" `
    -Headers @{ Authorization = "Bearer $env:FILMO_API_KEY"; "Accept-Language" = "en-US" }
  $response.data | ConvertTo-Json -Depth 5
} catch {
  # The body of the problem is in ErrorDetails; the status is in the exception.
  Write-Error $_.ErrorDetails.Message
  exit 1
}

# Alternative with curl.exe (the .exe matters: plain curl is an alias in Windows PowerShell 5.1):
# curl.exe -sS "$base/api/v1/account" -H "Authorization: Bearer $env:FILMO_API_KEY"

const base = process.env.FILMO_BASE_URL ?? "https://app.filmo.io";

const res = await fetch(`${base}/api/v1/account`, {
  headers: {
    Authorization: `Bearer ${process.env.FILMO_API_KEY}`,
    "Accept-Language": "en-US",
  },
});

// Check the status before parsing: a platform error may not be JSON.
if (!res.ok) {
  console.error(res.status, res.headers.get("content-type"), await res.text());
  process.exit(1);
}

const { data } = await res.json();
console.log(data.timezone, data.currency, data.addons, data.apiKey.scopes);

import os
import sys

import requests

base = os.environ.get("FILMO_BASE_URL", "https://app.filmo.io")

res = requests.get(
    f"{base}/api/v1/account",
    headers={"Authorization": f"Bearer {os.environ['FILMO_API_KEY']}", "Accept-Language": "en-US"},
    timeout=30,
)

# Check the status before parsing: a platform error may not be JSON.
if not res.ok:
    print(res.status_code, res.headers.get("content-type"), res.text, file=sys.stderr)
    sys.exit(1)

account = res.json()["data"]
print(account["timezone"], account["currency"], account["addons"], account["apiKey"]["scopes"])

The cURL tab is for macOS and Linux shells. On Windows PowerShell 5.1, curl is an alias of Invoke-WebRequest and the -H flag fails: use Invoke-RestMethod as above, or call curl.exe. In Command Prompt, variables are written %FILMO_API_KEY%, not $FILMO_API_KEY:

rem Command Prompt (cmd.exe): variables are %NAME%, not $NAME.
rem cmd.exe shows the key while you type it: use PowerShell if anyone can see your screen.
set /p FILMO_API_KEY=Filmo API key: 
curl.exe -sS "https://app.filmo.io/api/v1/account" -H "Authorization: Bearer %FILMO_API_KEY%"

A successful call returns 200 with the account inside the usual data envelope (the values below are fictitious):

{
  "data": {
    "name": "Acme Rentals",
    "timezone": "Europe/Madrid",
    "currency": "EUR",
    "country": "ES",
    "language": "en-US",
    "addons": ["crm"],
    "trial": { "active": false, "endsAt": null },
    "apiKey": {
      "id": "example-key-id",
      "name": "Inventory sync",
      "scopes": ["account:read", "items:read", "orders:read"]
    },
    "rateLimits": {
      "global": { "perMinute": 120 },
      "availability": { "perMinute": 30 }
    },
    "api": {
      "version": "1.0.0",
      "docsUrl": "https://docs.filmo.io"
    }
  }
}

Find the symptom, then the cause. Errors are RFC 9457 problems: branch on code, never on detail. Quote requestId to support (Support).

• Capabilities and limits: what v1 covers, its hard limits and what it does not do.
• Syncing data: keep your system in step with Filmo by polling for changes.
• Going live: the checklist before production.
• MCP quickstart: give an AI assistant the same access.