Overview

Spectra.fm provides an external API for programmatic access to your projects and exports, making it easy to integrate into your existing workflows.

API Documentation

Full API documentation is available at api.spectra.fm/docs.

The interactive docs include all endpoints, request/response schemas, and authentication details. Always refer to the live documentation for the most up-to-date information.

Authentication

All API requests require an API key in the X-API-Key header (or Authorization: Bearer <key>):

curl -X POST "https://api.spectra.fm/v1/projects/YOUR_PROJECT_ID/exports" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"combinations": [{"locale": "en", "theme": "light"}]}'

Get your API key at app.spectra.fm/settings/api-keys.

Export Flow (Async)

Exports are asynchronous. A typical integration follows this flow:

Fetch options (locales, themes, content variables)
- GET /v1/projects/:projectId/exports/options
Create export
- POST /v1/projects/:projectId/exports → returns exportId + statusUrl
Poll status
- GET /v1/projects/:projectId/exports/:exportId until status is completed
List artifacts
- GET /v1/projects/:projectId/exports/:exportId/artifacts
Download
- Use downloadUrl from the response, or call GET /v1/projects/:projectId/exports/download?objectKey=...

objectKey is an internal key; downloadUrl is ready to use.

Available Integrations

API - Programmatic access for exports and automation
GitHub Actions - Automate screenshot generation in CI/CD
Make - Visual automation workflows
n8n - Self-hosted workflow automation
Zapier - Native integration (live) + 5,000+ apps
MCP - Agent and toolchain integrations

SDKs

Official SDKs are coming soon to simplify integration in your preferred language.