Skip to main content
Every request to https://api.sigmora.org/v1 authenticates with a workspace API key sent as a bearer token. The only exception is the public OpenAPI document, GET /v1/openapi.json.

Get an API key

  1. Open the dashboard and go to Settings → API keys.
  2. Create a key with the role you need.
  3. Copy it immediately — it is shown once — and store it as SIGMORA_API_KEY.
If you cannot open Settings → API keys, ask a workspace owner to create a key for you. Keys are created in the dashboard only; the API cannot create keys.

Send the key

Put the key in the Authorization header:
A missing or malformed header answers 401 unauthorized:

A key belongs to one workspace

Each key is pinned to the workspace it was created in. That workspace is billed for the key’s work, and the key acts as the person who created it. You never send a workspace id in the URL or body, and a key cannot reach another workspace’s data: ids from other workspaces answer 404 not_found. If you send a workspace header (X-Workspace-Slug) that disagrees with the key, the request is refused rather than silently redirected. Omit the header — the key already names its workspace.

Roles

Reading your usage (GET /v1/usage) never needs a key that can spend.

Keep keys safe

  • Store keys in a secret manager or environment variable. Never commit them, and never ship them in browser or mobile code — call the API from your server.
  • Keys are stored hashed and cannot be recovered. If you lose one, create a new key.
  • Revoking a key in the dashboard takes effect within 30 seconds. Removing or suspending a member, or lowering their role, revokes the keys and connected apps they created.
  • A key cannot create another key, so a leaked key cannot be used to create persistent access. Rotate it and revoke the old one.
Agents and assistants such as ChatGPT and Claude can connect with OAuth instead of a key: the person signs in, chooses a workspace and approves the read, generate and publish scopes. OAuth tokens work on the MCP server only, not on the REST API. See MCP server.

Next steps

Quickstart

Make your first calls.

Rate limits

How many requests a key can make.