REST API Quickstart

Getting started with the footage.one REST API — from discovery at the root endpoint to your first search.

Root endpoint

Every call sensibly begins here:

curl https://app.footage.one/api/asset/

The response lists all available resources via the _links object — see Understanding HATEOAS. This makes the API navigable even without a spec file.

Auth

Most endpoints require a token. Send the token from https://app.footage.one/account via the apiKey header (no Bearer prefix):

curl -H "apiKey: YOUR_API_TOKEN" https://app.footage.one/api/asset/albums

Public endpoints (/public/*, /configuration/archive, root) also work without a token. For details see API tokens.

Examples

Search for assets

curl -H "apiKey: YOUR_API_TOKEN" \
  "https://app.footage.one/api/asset/search/assets?query=berlin&limit=5"

Asset detail

curl -H "apiKey: YOUR_API_TOKEN" \
  https://app.footage.one/api/asset/assets/asset-id-123

Create an album

curl -X POST \
  -H "apiKey: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Travels 2026"}' \
  https://app.footage.one/api/asset/albums

Pagination

Listing endpoints support offset and limit as query parameters:

GET /api/asset/albums?offset=20&limit=10

Maximum limit: 100. Default: 20.

Spec / Swagger UI

Interactive documentation: https://app.footage.one/api/asset/swagger-ui.html

Next steps

Zapier / Make HATEOAS