Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.signalark.app/llms.txt

Use this file to discover all available pages before exploring further.

Every request to the Signal Ark API must include a valid API key. Signal Ark uses API key authentication for all server-to-server requests — automated ingestion scripts, partner integrations, and custom tooling all authenticate the same way.

Get an API key

1

Open Security settings

In Signal Ark, go to Settings > Security > API Keys.
2

Generate a new key

Click Generate New Key. Give the key a descriptive name so you can identify it later (for example, “Production ingestion” or “Data partner — Flint”).
3

Assign scopes

Select the scopes the key needs. For signal ingestion, assign signals:write. Use the minimum scopes necessary for your use case.
4

Copy the key

Copy the key immediately and store it securely. Signal Ark displays the full key only once. If you lose it, you must generate a new one.
API keys are secrets. Do not commit them to version control, include them in client-side code, or share them in plain text. Rotate any key you suspect has been compromised and revoke the old one from Settings > Security > API Keys.

Key format

All Signal Ark API keys begin with the sak_ prefix:
sak_your_api_key_here
You can use this prefix to identify and validate Signal Ark keys programmatically in your configuration management or secret scanning tools.

Authenticate requests

Include your API key in the Authorization header of every request using the Bearer scheme:
Authorization: Bearer sak_your_api_key_here

Example request

curl -X POST https://www.signalark.app/_api/v1/signals/ingest \
  -H "Authorization: Bearer sak_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"signals": []}'
All requests must be made over HTTPS. HTTP requests are not accepted.

Base URL

All Signal Ark API endpoints share the same base URL:
https://www.signalark.app/_api
Append the versioned path to this base for every request. For example:
https://www.signalark.app/_api/v1/signals/ingest

Authentication errors

StatusMeaningWhat to do
401 UnauthorizedNo API key provided, or the key is malformed.Check that your Authorization header is present and uses the Bearer sak_... format.
403 ForbiddenThe key is valid but does not have the required scope for this operation.Go to Settings > Security > API Keys and update the key’s scopes, or generate a new key with the correct permissions.
If you receive a 401 error and your key looks correct, verify that you are not accidentally including extra whitespace or line breaks in the header value. Some HTTP libraries format multi-line header strings in ways that break authentication.