Skip to main content
GET
/
public
/
v1
/
projects
/
{projectId}
/
sources
/
{sourceId}
/
sample-data
Get source sample data
curl --request GET \
  --url https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/sample-data \
  --header 'x-api-key: <api-key>'
{
  "sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "schemaVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "table": "<string>",
  "columns": [
    {
      "id": "<string>",
      "type": "<string>",
      "nullable": true
    }
  ],
  "rows": [
    {}
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "count": 123,
    "total": 123
  }
}

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.

Query Parameters

​
table
string
required

Source table/entity identifier to sample.

​
limit
integer
default:25

Maximum number of rows to return.

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of rows to skip.

Required range: x >= 0

Response

Sample rows

​
sourceId
string<uuid>
required
​
schemaVersionId
string<uuid>
required
​
table
string
required
​
columns
object[]
required
​
rows
object[]
required
​
pagination
object
required