API Reference

REST API

The REST API exposes hosted control-plane, SQL, agent, evidence, proposal, and backup workflows.

Overview

Use the OpenAPI document for generated clients and contract tests.

Control-plane routes live under /v1/control.

Gateway routes for runtime SQL and agent traffic live on the canonical Synapsor API domain.

Developer notes

Use HTTPS only.
Set explicit request timeouts.
Keep idempotency keys for retried creates.
Keep operator session tokens out of browser-accessible storage.

Authentication

HTTP

Authorization: Bearer <database-api-key-or-approved-session-token>
Content-Type: application/json
X-Request-Id: <optional-client-request-id>

Notes:
  Use database API keys for app/runtime traffic.
  Use approved account session tokens for control-plane console actions.
  X-Request-Id is caller-defined and helps correlate logs/support tickets.

Examples

bash

# SYNAPSOR_API_KEY must be scoped to the database you want to query.
curl -fsS https://synapsor.ai/v1/sql \
  -H "Authorization: Bearer $SYNAPSOR_API_KEY" \
  -H "X-Request-Id: req_123" \
  -H "Content-Type: application/json" \
  --data '{"sql":"SELECT 1;"}'