Jobs

List pipeline jobs

get

/api/v1/workspaces/{wsId}/jobs

Lists pipeline runs for the workspace. Proxies to data-service GET /api/internal/pipeline-runs/workspace/{wsId}. Results are paginated in-app (limit, cursor). Jobs include connector imports, digital-twin train/run-pipeline/discover, report generate, etc. Use the returned job ids to poll GET /jobs/{id} or cancel via POST /jobs/{id}/cancel.

Authorizations

AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Path parameters

wsIdstringRequired

Path parameter: wsId

Example: 123

Query parameters

limitnumber · min: 1 · max: 1000Optional

Page size (1-1000, default 50).

Example: 1

cursorstringOptional

Opaque cursor from a previous response's pagination.cursor.

Example: example

Responses

200

Successful response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too Many Requests; the response carries Retry-After

application/json

500

Internal Server Error

application/json

get/api/v1/workspaces/{wsId}/jobs

GET /api/v1/workspaces/{wsId}/jobs HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [],
  "pagination": {
    "cursor": "text",
    "hasMore": true,
    "total": 1
  }
}

Get job status

get

/api/v1/workspaces/{wsId}/jobs/{id}

Returns the pipeline run by id. Proxies to data-service GET /api/internal/pipeline-runs/by-id/{id}. Use to poll status after a 202 from import, train, run-pipeline, discover, or report generate. Response shape is defined by the data-service (e.g. status, progress, result).

Authorizations

AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Path parameters

wsIdstringRequired

Path parameter: wsId

Example: 123

idstringRequired

Path parameter: id

Example: 123

Responses

200

Successful response

application/json

dataany of · nullableRequired

Payload not declared in this repo

stringOptional

or

numberOptional

or

booleanOptional

or

or

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too Many Requests; the response carries Retry-After

application/json

500

Internal Server Error

application/json

get/api/v1/workspaces/{wsId}/jobs/{id}

GET /api/v1/workspaces/{wsId}/jobs/{id} HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": "text"
}

Cancel a running job

post

/api/v1/workspaces/{wsId}/jobs/{id}/cancel

Cancels a running pipeline job. Proxies to data-service POST /api/pipeline-runs/{id}/cancel. Returns jobId and status cancelled. Only running jobs can be cancelled; completed or already-cancelled jobs may return success without effect.

Authorizations

AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Path parameters

wsIdstringRequired

Path parameter: wsId

Example: 123

idstringRequired

Path parameter: id

Example: 123

Responses

200

Successful response

application/json

dataany of · nullableRequired

Payload not declared in this repo

stringOptional

or

numberOptional

or

booleanOptional

or

or

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too Many Requests; the response carries Retry-After

application/json

500

Internal Server Error

application/json

post/api/v1/workspaces/{wsId}/jobs/{id}/cancel

POST /api/v1/workspaces/{wsId}/jobs/{id}/cancel HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": "text"
}