API Overview

Frametail exposes a versioned HTTP JSON API for automation, SDKs, and custom integrations. All routes documented here live under /api/v1.

Base URL

• Dashboard / app origin: use your deployment host, for example https://app.example.com, so endpoints become https://app.example.com/api/v1/....
• TypeScript SDK default: the frametail package defaults to https://api.frametail.com unless you override baseUrl in configuration.

Always use HTTPS in production.

Versioning

The path prefix /api/v1 is the supported public surface. If a future version is introduced, it will use a new prefix (for example /api/v2) while v1 remains stable for existing clients.

Request and response format

• Content type: send JSON bodies with Content-Type: application/json on POST, PUT, and other methods that accept a body.
• Responses: successful responses return JSON payloads. Errors return JSON objects with an error field (see Errors).
• Character encoding: UTF-8.

Resource map

Each area has a dedicated reference page with methods, paths, and parameters.

Authentication

Every call requires an API key and a project scope header. See HTTP authentication.

Related

• TypeScript SDK — recommended client with typed helpers and optional tracing helpers.