Documentation menu

Supernova API#

Use https://api.supernova.ai to query data, inspect the catalog, manage sources, follow runs, trigger sends, read logs and usage, and manage personal access tokens.

bash
curl https://api.supernova.ai/whoami \
  -H "Authorization: Bearer pat_..."

Contract#

API paths do not contain a version segment. Responses include Supernova-Version for observation and Request-Id for support. Additive response fields may appear; clients should ignore fields they do not understand.

Resource objects have an object discriminator and prefixed ids. Collections use {"object":"list","data":[...]} and expose has_more with a cursor when the resource is paginated.

Resources#

ResourcePurpose
QueriesSubmit SQL and retrieve Parquet or inline results
JobsList, inspect, follow, cancel, and retrieve run results
CatalogList schemas and inspect table columns
SourcesList, create, change, test, and delete sources
SyncsStart a source sync and follow progress
SendsInspect and control configured sends
LogsRead source errors and schema changes
UsageRead monthly metered usage and projected cost
PATsCreate, list, and revoke personal access tokens

Rate limits#

Each caller may make 120 requests per minute. Each organization may make 600 per minute across callers. A 429 rate_limited response includes Retry-After in seconds. Polling and stream reconnections count as requests.

Idempotency#

Mutation endpoints that advertise idempotency accept Idempotency-Key. A replay under the same principal and organization returns the original resource. Reusing a key with different input returns a 409 rather than guessing which operation you intended.