Stream Job Updates

curl --request GET \
  --url https://api.goldilocksai.app/jobs/{job_id}/stream \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.goldilocksai.app/jobs/{job_id}/stream', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

id: e1234567-e89b-12d3-a456-426614174000
event: job_update
data: {"event_id":"e1234567-e89b-12d3-a456-426614174000","job_id":"550e8400-e29b-41d4-a716-446655440000","timestamp":"2025-12-23T10:30:05.000Z","stage":"Extract Requirements","message":"Extracting requirements from your query","status":"IN_PROGRESS","is_final":false,"metadata":null,"error_details":null}

Endpoints

Jobs

Stream real-time progress updates for asynchronous operations like searches and profile fetching using Server-Sent Events (SSE). This endpoint provides live updates on job status, current processing stage, and completion status. You’ll receive events as the job progresses through different stages, with a final event when the job completes or encounters an error. The stream automatically closes after the final event.

Important: Retrieving profiles during search

During the “Aggregate Search Results” stage, you’ll receive events containing search_id in the metadata whenever a new batch of profiles is matched. Each time you receive this event, you can call GET /searches/{search_id}/profiles to retrieve the latest profiles found so far. This allows you to display results progressively to users rather than waiting for the entire search to complete.

GET

jobs

{job_id}

stream

Stream Job Updates

curl --request GET \
  --url https://api.goldilocksai.app/jobs/{job_id}/stream \
  --header 'X-API-Key: <api-key>'

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

fetch('https://api.goldilocksai.app/jobs/{job_id}/stream', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

id: e1234567-e89b-12d3-a456-426614174000
event: job_update
data: {"event_id":"e1234567-e89b-12d3-a456-426614174000","job_id":"550e8400-e29b-41d4-a716-446655440000","timestamp":"2025-12-23T10:30:05.000Z","stage":"Extract Requirements","message":"Extracting requirements from your query","status":"IN_PROGRESS","is_final":false,"metadata":null,"error_details":null}

Authorizations

X-API-Key

string

header

required

API key for authentication. Obtain your API key via the web application.

Path Parameters

job_id

string<uuid>

required

Unique identifier of the job

Response

SSE stream established successfully

Server-Sent Events stream with job updates.

Each event contains a JSON payload with job progress information. Events are sent as they occur during job execution.

The stream closes automatically after the final event (is_final: true).