Batches API v1Alpha

Get the job dependency graph for a batch

Changed on

Get every job's parent ids for the whole batch, for rendering a job dependency DAG. Jobs with no parents have an empty parent_ids array. Paginated by job_offset — see JobOffsetPagination. Job metadata (name, state) is not included here; join client-side against the existing jobs list endpoint by job_id.

get/api/v1alpha/batches/{batch_id}/job_graph

Request

  • Base URL: {{ base_url }}
  • URL: {{ base_url }}/api/v1alpha/batches/{batch_id}/job_graph
  • Auth: none declared

Path parameters

batch_idnumber required

The ID of the batch.

Query parameters

job_offsetinteger

Job id offset to page from. Job ids within a batch are dense (1..n_jobs), so this maps directly onto a job_id range rather than a real SQL OFFSET. Defaults to 0.

page_sizeinteger

Number of jobs to include in this page (not number of edges). Defaults to 50, capped at 1000.

Response

Successfully retrieved the job graph for the batch.

Changes