List Source Generation Events

List source generation events

curl --request GET \
  --url https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "schemaVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger": "<string>",
    "status": "<string>",
    "queuedAt": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z",
    "durationMs": 123,
    "totalInsertedRows": 123,
    "billableRows": 123,
    "errorMessage": "<string>",
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

GET

public

projects

{projectId}

sources

{sourceId}

generation-events

List source generation events

curl --request GET \
  --url https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.synthbrew.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "sourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "schemaVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger": "<string>",
    "status": "<string>",
    "queuedAt": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z",
    "durationMs": 123,
    "totalInsertedRows": 123,
    "billableRows": 123,
    "errorMessage": "<string>",
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

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

limit

integer

default:50

Maximum number of latest events to return (newest first).

Required range: 1 <= x <= 200

Response

Generation events

string<uuid>

slug

string

sourceId

string<uuid>

projectId

string<uuid>

teamId

string<uuid>

schemaVersionId

string<uuid>

trigger

string

Generation trigger type (populate or regenerate).

status

string

Event status (queued, active, success, failed).

queuedAt

string<date-time>

startedAt

string<date-time> | null

finishedAt

string<date-time> | null

durationMs

integer | null

Duration in milliseconds when available.

totalInsertedRows

integer

Total generated rows inserted for this run.

billableRows

integer

Rows counted toward billing/usage for this run.

errorMessage

string | null

Sanitized error text when generation fails.

metadata

object | null

Additional context such as mode, targetProvider, targetSchema, targetProjectRef, and queue job details.

createdAt

string<date-time>

updatedAt

string<date-time> | null

Get Source Generation Job Status

Runtime reference

Runtime endpoints

Public v1 endpoints

Projects

Schemas

Sources

List Source Generation Events

Authorizations

Path Parameters

Query Parameters

Response