Filmsquare HelpDocs

Connect your tools

How do I get an API key and call the API?

Updated .md

On this page
  1. Make a personal key
  2. Make a workspace key
  3. Find every route

The app, your own Claude and your scripts all call the same REST API, with the same roles. A key starts with fsk_, belongs to one workspace and never has more rights than the person it acts for. Send it as Authorization: Bearer <key> to https://app.filmsquare.ai/v1.

Make a personal key #

A personal key works for any role.

  1. Open Settings, then Claude.
  2. Choose Use a personal key instead.
  3. Give it a Name of the key and choose Create a personal key.
  4. Copy the key. It is shown once.

To test it:

curl -s "https://app.filmsquare.ai/v1/me" -H "Authorization: Bearer $FS_KEY"

A personal key can do what your role allows, except manage keys. To stop it, choose Disconnect on the same page.

Make a workspace key #

A producer or owner can make keys with a chosen role through the API, including for an agent user. The role can never be above your own, and the call must come from a signed-in session: a personal key or a Claude connection cannot make keys. The request and the list and revoke routes are in the docs under a workspace API key.

Find every route #

The full reference is one public OpenAPI document at https://app.filmsquare.ai/v1/openapi.json. See the OpenAPI reference for how to read it, and the API overview for the errors you will meet. To be told when a take is ready instead of polling, see get a webhook when a take is ready.

Email us