Flamesight API reference
Explore Risk, Event, Simulation, Detection, and Credentials endpoints with complete parameter contracts, working request bodies, and copyable examples.
Product APIs accept workspace-scoped PATs and service credentials in the Authorization header.
Create API credentialsAccept your Flamesight invite and sign in to confirm your workspace access.
Open API Tokens and create a PAT for human tooling or a service credential for backend systems.
Select only the credential actions your integration needs.
Send the token in the Authorization header and call the product API base URL.
Authentication
Choose a credential type based on who or what is calling the API.
Personal Access Token
Best for notebooks, Postman, command-line testing, and human-operated workflows.
Service Credential
Best for customer backends, scheduled jobs, CI/CD, workers, and machine-to-machine usage. One holding credential.manage can also manage the service credentials of its own workspace.
Browser Session
Used by the Flamesight web app for account and workspace administration, including personal access tokens. A workspace admin creates the first service credential by hand here, and rotation is a browser-only route.
Request Pattern
All product API credentials use the standard bearer header.
Authorization: Bearer fs_pat_...
Authorization: Bearer fs_svc_...Credentials are scoped to one workspace, restricted to selected actions, expire at the time you set, and can be revoked from the Account page. Secrets are shown once when created.
API Reference
ReDoc-style contracts, examples, authorization requirements, and safe live queries.
Risk API
Read annual burn probability for a precisely defined circular area.
API base URL
https://flamesight.pinepeak.co.uk/api/v1/risk
Status Codes
Common API responses and what to do next.
| Code | Meaning |
|---|---|
| 400 | The request shape, parameters, or payload are invalid. |
| 401 | No valid user session, PAT, or service credential was supplied. |
| 403 | The credential is valid but does not have the required workspace action or entitlement. |
| 404 | The requested resource does not exist in the current workspace scope. |
| 409 | The request conflicts with current workspace state, quota, or membership rules. Creating a service credential returns it when the workspace is at its active credential cap, 25 by default; only revoking a credential clears it. |
| 429 | The workspace or service is rate limited. Creating a service credential returns it when the workspace has spent its monthly creation limit, 100 by default; that one clears when the month rolls over. |
| 501 | The documented route is reserved but is not currently available. |
| 5xx | A Flamesight service or downstream dependency failed. Retry safely where the endpoint is idempotent. |
Security Checklist
Keep API access narrow, auditable, and recoverable.