Skip to main content
GET
/
public
/
v1
/
projects
/
{projectId}
/
sources
/
{sourceId}
/
generation-jobs
/
{jobId}
Get source generation job status
curl --request GET \
  --url https://your-synthbrew-server.com/api/public/v1/projects/{projectId}/sources/{sourceId}/generation-jobs/{jobId} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "status": "<string>",
  "queueName": "<string>",
  "attemptsMade": 123,
  "finishedOn": "2023-11-07T05:31:56Z",
  "failedReason": "<string>",
  "result": {}
}

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.

​
jobId
string
required

Queue job identifier returned in generationJob.id from create/regenerate responses.

Response

Job status

Background generation job summary when queue mode is enabled.

​
id
string

Job ID used by /generation-jobs/{jobId}.

​
status
string

Current queue status (for example waiting, active, completed, failed).

​
queueName
string | null

Queue name handling this generation job.

​
attemptsMade
integer | null

Number of processing attempts made so far.

​
finishedOn
string<date-time> | null

Completion timestamp when the job has finished.

​
failedReason
string | null

Failure reason when status is failed.

​
result
object

Optional result payload, typically including generation audit details.