Developer quickstart

Signaliz exposes the same workspace products through REST, MCP, the CLI, and the TypeScript SDK.

1. Create a key

Open Settings → Connect → API keys, create a scoped key, and keep it in a secret manager.

2. Run a no-spend preflight

curl -sS https://api.signaliz.com/functions/v1/api/v1/company-signals \
  -H "Authorization: Bearer $SIGNALIZ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"example.com","dry_run":true}'

dry_run: true returns a conservative plan without provider calls, jobs, writes, or credit spend.

3. Run the request

Remove dry_run when you are ready. Save the returned run ID, job ID, idempotency key, credit receipt, and source URLs. They are the recovery and audit trail for the work.

4. Choose a client

REST for any language or HTTP system.
MCP for Claude, ChatGPT, Codex, Cursor, n8n, and compatible tools.
CLI for shell workflows, JSONL, and operator automation.
TypeScript SDK for typed application integration and built-in durable-job helpers.

The production REST base is https://api.signaliz.com/functions/v1/api/v1. Version 2 schemas are also available under /api/v2/. Use the generated OpenAPI document in Settings → API reference as the exact schema source.