Skip to main content

Documentation Index

Fetch the complete documentation index at: https://synthbrew.com/docs/llms.txt

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

The runtime API gives you CRUD access to generated source data. Looking for project/schema/source management endpoints? See Public API v1.

​
Base URL

{SYNTHBREW_API_HOST}/api

​
Endpoint pattern

/runtime/{sourceId}/{table}
/runtime/{sourceId}/{table}/{id}
  • sourceId: source UUID
  • table: entity/table id from the source schema
  • id: primary key value for record-specific operations

​
Authentication

Runtime endpoints require a source API key in the x-api-key header. 
x-api-key: sb_src_...
Runtime auth is separate from app user auth. Use source API keys, not app Bearer tokens, for /runtime/* endpoints.

​
List query features

GET /runtime/{sourceId}/{table} supports pagination and query semantics:
  • limit, offset
  • fields (comma-separated projection)
  • sort (field:asc|desc)
  • filters.<field>.<operator>=value
  • populate and populate.<field>.fields
Supported filter operators:
  • $eq, $ne, $gt, $gte, $lt, $lte
  • $in, $notIn
  • $contains, $containsi, $startsWith, $endsWith
  • $null

​
Synthbrew API reference

For team-scoped management operations (projects, schemas, sources, regeneration), use Public API v1.