Skip to main content
GET
/
public
/
v1
/
projects
/
{projectId}
/
sources
/
{sourceId}
/
runtime-docs
Get source runtime docs
curl --request GET \
  --url https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/runtime-docs \
  --header 'x-api-key: <api-key>'
{
  "sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "schemaVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "baseUrl": "https://api.synthbrew.com/api",
  "runtimeBasePath": "/runtime/11111111-1111-1111-1111-111111111111",
  "auth": {
    "headerName": "x-api-key",
    "keyPrefix": "sb_src_"
  },
  "entities": [
    {
      "id": "<string>",
      "label": "<string>",
      "description": "<string>",
      "primaryKey": [
        "<string>"
      ],
      "fields": [
        {
          "id": "<string>",
          "label": "<string>",
          "description": "<string>",
          "type": "<string>",
          "nullable": true,
          "references": {
            "entity": "<string>",
            "field": "<string>",
            "relation": "many-to-one",
            "pick": "random",
            "onDelete": "restrict",
            "onUpdate": "restrict"
          }
        }
      ]
    }
  ],
  "examples": {
    "curl": "<string>",
    "fetch": "<string>"
  }
}

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.

Authorizations

​
x-api-key
string
header
required

Team API key created under /api/api-keys. Prefix: sb_api_.

Path Parameters

​
projectId
string<uuid>
required

Project UUID in the team associated with the API key.

​
sourceId
string<uuid>
required

Source UUID. For runtime endpoints this identifies the source backing the table; for public v1 it identifies the source resource inside the project.

Response

Runtime docs

​
sourceId
string<uuid>
​
schemaVersionId
string<uuid>
​
baseUrl
string
Example:

"https://api.synthbrew.com/api"

​
runtimeBasePath
string
Example:

"/runtime/11111111-1111-1111-1111-111111111111"

​
auth
object
​
entities
object[]
​
examples
object