Skip to main content
    Ivy Biosciences Docs/Call the platform/API/Reference/Reference/Jobs/GET /v1/jobs/{jobId}/events

    GET /v1/jobs/{jobId}/events

    Stream job events — Server-Sent Events stream of status and progress updates for one job.

    Auth: required. Send an ivy_ API key (Authorization: Bearer ivy_…), a signed-in session token (Authorization: Bearer …) or the session cookie (browser sessions). See Authentication.

    Server-Sent Events stream of status and progress updates for one job. The stream opens with a current-state snapshot when available and closes after a terminal status, after about 290 seconds, or when the client disconnects. Comment heartbeats are sent every 15 seconds; reconnect to keep watching. Accepts an ivy_ API key, a signed-in session token or the session cookie. A project-scoped key only reaches jobs in its projects.

    Request

    Path parameters

    jobIdstring

    Job UUID.

    Responses

    200 OK

    Event stream. Each event is sent as event: <name> followed by data: <JSON>. Event names: subscribed ({jobId, type}), job_update (JobEventUpdate), close ({code, reason}) when the upstream stream ends, error ({error}) when it fails, and message ({raw}) for a payload that is not JSON. Other typed events from the job stream are forwarded under their own type name with the payload unchanged.

    400 Bad Request

    Missing job id, non-GET method, or an Accept header that excludes text/event-stream

    Response shape: object

    401 Unauthorized

    Authentication required

    Response shape: object

    403 Forbidden

    The caller cannot access this job

    Response shape: object

    404 Not Found

    The job is outside the API key's project scope

    Response shape: object

    503 Service Unavailable

    No credential is available to open the job stream (code missing_upstream_credentials), or the job stream is not configured

    Response shape: object

    curl -X GET 'https://ivybiosciences.com/api/v1/jobs/{jobId}/events' \
      -H "Authorization: Bearer $IVY_API_KEY"

    Was this page helpful?

    Loading...