Create or update a pipeline

Creates a new pipeline or updates an existing one. The pipeline object is provided in the request body as a PipelineInputRequest.

Auth
Request Body

Pipeline definition

PipelineInputRequestobject
pipelineobject
contextobject?
*object
createdAt
DateTimeobject
descriptionstring?
enabledboolean
idinteger
interruptboolean
latestRunIdinteger
meta
Metaobject
codeLocationstring?
ownerstring?
teamstring?
namestring
notificationChannels
NotificationPayloadobject
alertsEnabledboolean
configuredNotificationGroupIdsarray[integer]
notifyOnarray[string]

Enum: ERROR,WARNING,SUCCESS,ALL

notifyOnSuccessboolean
notifyOnWarningboolean
reNotifyFactorinteger
severitystring?

Enum: LOW,MEDIUM,HIGH,CRITICAL

tagsarray[string]
stringstring
pipelineBaselineMetric
PipelineBaselineMetricobject
includeSuccessfulRunsOnlyboolean
metricsinteger
unitstring

Enum: DAYS,RUNS

schedulestring?
scheduledboolean
schedulerTypestring

Enum: INTERNAL,EXTERNAL

sourceTypestring

Enum: AIRFLOW,AZURE_DATA_FACTORY,TRINO,OTHERS,AUTOSYS,SPARK,DBT,FIVETRAN,SNAPLOGIC

tagsarray[object]
createdAt
DateTimeobject
displayNamestring
idinteger
namestring
updatedAt
DateTimeobject
uidstring
updatedAt
DateTimeobject
PUT /torch-pipeline/api/pipelines
Copy
Responses
200

Created or updated pipeline

PipelineResponseobject
pipelineobject
contextobject?
*object
createdAt
DateTimeobject
descriptionstring?
enabledboolean
idinteger
interruptboolean
latestRunIdinteger
meta
Metaobject
codeLocationstring?
ownerstring?
teamstring?
namestring
notificationChannels
NotificationPayloadobject
alertsEnabledboolean
configuredNotificationGroupIdsarray[integer]
notifyOnarray[string]

Enum: ERROR,WARNING,SUCCESS,ALL

notifyOnSuccessboolean
notifyOnWarningboolean
reNotifyFactorinteger
severitystring?

Enum: LOW,MEDIUM,HIGH,CRITICAL

tagsarray[string]
stringstring
pipelineBaselineMetric
PipelineBaselineMetricobject
includeSuccessfulRunsOnlyboolean
metricsinteger
unitstring

Enum: DAYS,RUNS

schedulestring?
scheduledboolean
schedulerTypestring

Enum: INTERNAL,EXTERNAL

sourceTypestring

Enum: AIRFLOW,AZURE_DATA_FACTORY,TRINO,OTHERS,AUTOSYS,SPARK,DBT,FIVETRAN,SNAPLOGIC

tagsarray[object]
createdAt
DateTimeobject
displayNamestring
idinteger
namestring
updatedAt
DateTimeobject
uidstring
updatedAt
DateTimeobject
Response
Copy

Delete a pipeline

Deletes the pipeline with the given ID.

Auth
Path Params
pipelineIdstring

Pipeline ID

DELETE /torch-pipeline/api/pipelines/{pipelineId}
Copy
Responses
200

Pipeline deleted successfully

No response body
404

Pipeline not found

409

Pipeline could not be deleted due to a conflict

Response
Copy

Update pipeline graph with jobs

Updates the pipeline's job graph. The request specifies the job nodes and their relationships within the pipeline DAG.

Auth
Path Params
pipelineIdstring

Pipeline ID

Request Body

Job graph definition

JobRequestarray[object]
contextobject?
*object
descriptionstring?
inputsarray[object]
assetIdinteger
assetTypestring?
asset_uidstring?
jobUidstring?
namestring?
ownerstring?
parentNodeIdinteger
sourcestring?
sourceTypestring?
teamstring?
meta
Metaobject
codeLocationstring?
ownerstring?
teamstring?
namestring
outputsarray[object]
assetIdinteger
assetTypestring?
asset_uidstring?
jobUidstring?
namestring?
ownerstring?
parentNodeIdinteger
sourcestring?
sourceTypestring?
teamstring?
parentNodeIdinteger
pipeLineRunIdinteger
uidstring
versioninteger
PUT /torch-pipeline/api/pipelines/{pipelineId}/jobs
Copy
Responses
200

Updated node graph

NodeResponseobject
nodeobject
alertsCountinteger
assetIdinteger
contextobject?
*object
createdViastring

Enum: PIPELINE_CREATION,MANUAL_ADDITION,QUERY_LOG_ANALYSIS,AUTO_DERIVED_ASSET,DEPENDS_ON_RELATION,CRAWLER_CREATION

descriptionstring?
idinteger
jobNodeMetricarray[object]
Metricobject
changenumber
denominatorinteger
namestring
typestring

Enum: COST,DURATION,RECORDS_PROCESSED,RELIABILITY

unitstring?
valuenumber
jobStatusstring?

Enum: SUCCESS,ERROR,ABORTED,RUNNING

meta
Metaobject
codeLocationstring?
ownerstring?
teamstring?
namestring?
parentIdinteger
pipelineIdinteger
reliabilityPolicySummaryarray[object]
PolicySummaryobject
abortedinteger
errorinteger
policyTypestring

Enum: DATA_QUALITY,RECONCILIATION,EQUALITY,DATA_DRIFT,SCHEMA_DRIFT,DATA_CADENCE,PROFILE_ANOMALY,AUTO_ANOMALY

successinteger
totalinteger
statusstring

Enum: ACTIVE,STALE,DELETED

typestring

Enum: ASSET,FUNCTIONAL

uidstring?
versionIdinteger
400

Invalid job request

Response
Copy

Get a pipeline by identity

Returns details of a pipeline identified by its numeric ID or name.

Auth
Path Params
identitystring

Pipeline ID (numeric) or pipeline name

GET /torch-pipeline/api/pipelines/{identity}
Copy
Responses
200

Pipeline details

PipelineResponseobject
pipelineobject
contextobject?
*object
createdAt
DateTimeobject
descriptionstring?
enabledboolean
idinteger
interruptboolean
latestRunIdinteger
meta
Metaobject
codeLocationstring?
ownerstring?
teamstring?
namestring
notificationChannels
NotificationPayloadobject
alertsEnabledboolean
configuredNotificationGroupIdsarray[integer]
notifyOnarray[string]

Enum: ERROR,WARNING,SUCCESS,ALL

notifyOnSuccessboolean
notifyOnWarningboolean
reNotifyFactorinteger
severitystring?

Enum: LOW,MEDIUM,HIGH,CRITICAL

tagsarray[string]
stringstring
pipelineBaselineMetric
PipelineBaselineMetricobject
includeSuccessfulRunsOnlyboolean
metricsinteger
unitstring

Enum: DAYS,RUNS

schedulestring?
scheduledboolean
schedulerTypestring

Enum: INTERNAL,EXTERNAL

sourceTypestring

Enum: AIRFLOW,AZURE_DATA_FACTORY,TRINO,OTHERS,AUTOSYS,SPARK,DBT,FIVETRAN,SNAPLOGIC

tagsarray[object]
createdAt
DateTimeobject
displayNamestring
idinteger
namestring
updatedAt
DateTimeobject
uidstring
updatedAt
DateTimeobject
404

Pipeline not found

Response
Copy

List all pipelines with summary

Returns a paginated summary of all pipelines. Supports filtering by pipeline source, instrumentation type, and namespaces.

Auth
Query String
pipelineSourcestring

Filter by pipeline source (e.g., AIRFLOW)

instrumentedBystring

Filter by instrumentation method (e.g., SDK, OPENLINEAGE)

namespacesstring

Filter by namespaces

pagestring

Page number (0-based)

sizestring

Number of items per page

sortstring

Sort field and direction

GET /torch-pipeline/api/pipelines/summary
Copy
Responses
200

Paginated pipeline summary

PipelinesListingResponseobject
metaobject
countinteger
pageinteger
sizeinteger
pipelinesarray[object]
assetNodesCountinteger
functionalNodesCountinteger
latestRunFinishedAt
DateTimeobject
latestRunIdinteger
latestRunResultstring?
latestRunStartedAt
DateTimeobject
latestRunVersionIdinteger
pipelineSummaryobject
idinteger
meta
Metaobject
codeLocationstring?
ownerstring?
teamstring?
namestring
uidstring
policyCountsobject
*integer
sourceTypestring

Enum: AIRFLOW,AZURE_DATA_FACTORY,TRINO,OTHERS,AUTOSYS,SPARK,DBT,FIVETRAN,SNAPLOGIC

totalRunsCountinteger
Response
Copy

Get pipeline graph

Returns the full pipeline graph including jobs and assets. Optionally filtered by version, run, and node status.

Auth
Path Params
pipelineIdstring

Pipeline ID

Query String
versionIdstring

Specific graph version ID

runIdstring

Pipeline run ID to scope the graph

nodeStatusstring

Filter nodes by status (ALL, RUNNING, FAILED, etc.)

GET /torch-pipeline/api/pipelines/{pipelineId}/graph
Copy
Responses
200

Pipeline graph details

PipelineDetailsResponseobject
detailsobject
edgesarray[object]
fromAssetTypestring?

Enum: ASSET,FUNCTIONAL

fromIdinteger
idinteger
toAssetTypestring?

Enum: ASSET,FUNCTIONAL

toIdinteger
versionIdinteger
nodesarray[object]
alertsCountinteger
assetIdinteger
contextobject?
*object
createdViastring

Enum: PIPELINE_CREATION,MANUAL_ADDITION,QUERY_LOG_ANALYSIS,AUTO_DERIVED_ASSET,DEPENDS_ON_RELATION,CRAWLER_CREATION

descriptionstring?
idinteger
jobNodeMetricarray[object]
Metricobject
changenumber
denominatorinteger
namestring
typestring

Enum: COST,DURATION,RECORDS_PROCESSED,RELIABILITY

unitstring?
valuenumber
jobStatusstring?

Enum: SUCCESS,ERROR,ABORTED,RUNNING

meta
Metaobject
codeLocationstring?
ownerstring?
teamstring?
namestring?
parentIdinteger
pipelineIdinteger
reliabilityPolicySummaryarray[object]
PolicySummaryobject
abortedinteger
errorinteger
policyTypestring

Enum: DATA_QUALITY,RECONCILIATION,EQUALITY,DATA_DRIFT,SCHEMA_DRIFT,DATA_CADENCE,PROFILE_ANOMALY,AUTO_ANOMALY

successinteger
totalinteger
statusstring

Enum: ACTIVE,STALE,DELETED

typestring

Enum: ASSET,FUNCTIONAL

uidstring?
versionIdinteger
pipelineobject
contextobject?
*object
createdAt
DateTimeobject
descriptionstring?
enabledboolean
idinteger
interruptboolean
latestRunIdinteger
meta
Metaobject
codeLocationstring?
ownerstring?
teamstring?
namestring
notificationChannels
NotificationPayloadobject
alertsEnabledboolean
configuredNotificationGroupIdsarray[integer]
notifyOnarray[string]

Enum: ERROR,WARNING,SUCCESS,ALL

notifyOnSuccessboolean
notifyOnWarningboolean
reNotifyFactorinteger
severitystring?

Enum: LOW,MEDIUM,HIGH,CRITICAL

tagsarray[string]
stringstring
pipelineBaselineMetric
PipelineBaselineMetricobject
includeSuccessfulRunsOnlyboolean
metricsinteger
unitstring

Enum: DAYS,RUNS

schedulestring?
scheduledboolean
schedulerTypestring

Enum: INTERNAL,EXTERNAL

sourceTypestring

Enum: AIRFLOW,AZURE_DATA_FACTORY,TRINO,OTHERS,AUTOSYS,SPARK,DBT,FIVETRAN,SNAPLOGIC

tagsarray[object]
createdAt
DateTimeobject
displayNamestring
idinteger
namestring
updatedAt
DateTimeobject
uidstring
updatedAt
DateTimeobject
pipelineRun
PipelineRunobject
argsobject?
*object
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
continuationIdstring?
errorEventsinteger
externalRunIdstring?
finishedAt
DateTimeobject
idinteger
pipelineIdinteger
resultstring

Enum: RUNNING,SUCCESS,FAILURE,CANCELLED

startedAt
DateTimeobject
statusstring

Enum: STARTED,COMPLETED,FAILED,ABORTED

successEventsinteger
tenantIdstring?
versionIdinteger
warningEventsinteger
metricsarray[object]
changenumber
denominatorinteger
namestring
typestring

Enum: COST,DURATION,RECORDS_PROCESSED,RELIABILITY

unitstring?
valuenumber
400

Invalid or missing pipelineId

Response
Copy

Create a pipeline run

Creates a new run for the specified pipeline.

Auth
Path Params
pipelineIdstring

Pipeline ID

Request Body

Pipeline run definition

PipelineRunRequestobject
runobject
argsobject?
*object
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
continuationIdstring?
errorEventsinteger
externalRunIdstring?
finishedAt
DateTimeobject
idinteger
pipelineIdinteger
resultstring

Enum: RUNNING,SUCCESS,FAILURE,CANCELLED

startedAt
DateTimeobject
statusstring

Enum: STARTED,COMPLETED,FAILED,ABORTED

successEventsinteger
tenantIdstring?
versionIdinteger
warningEventsinteger
POST /torch-pipeline/api/pipelines/{pipelineId}/runs
Copy
Responses
200

Created pipeline run

PipelineRunRequestobject
runobject
argsobject?
*object
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
continuationIdstring?
errorEventsinteger
externalRunIdstring?
finishedAt
DateTimeobject
idinteger
pipelineIdinteger
resultstring

Enum: RUNNING,SUCCESS,FAILURE,CANCELLED

startedAt
DateTimeobject
statusstring

Enum: STARTED,COMPLETED,FAILED,ABORTED

successEventsinteger
tenantIdstring?
versionIdinteger
warningEventsinteger
Response
Copy

Update a pipeline run

Updates an existing pipeline run by its run ID.

Auth
Path Params
runIdstring

Pipeline run ID

Request Body

Updated pipeline run data

PipelineRunRequestobject
runobject
argsobject?
*object
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
continuationIdstring?
errorEventsinteger
externalRunIdstring?
finishedAt
DateTimeobject
idinteger
pipelineIdinteger
resultstring

Enum: RUNNING,SUCCESS,FAILURE,CANCELLED

startedAt
DateTimeobject
statusstring

Enum: STARTED,COMPLETED,FAILED,ABORTED

successEventsinteger
tenantIdstring?
versionIdinteger
warningEventsinteger
PUT /torch-pipeline/api/pipelines/runs/{runId}
Copy
Responses
200

Updated pipeline run

PipelineRunRequestobject
runobject
argsobject?
*object
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
continuationIdstring?
errorEventsinteger
externalRunIdstring?
finishedAt
DateTimeobject
idinteger
pipelineIdinteger
resultstring

Enum: RUNNING,SUCCESS,FAILURE,CANCELLED

startedAt
DateTimeobject
statusstring

Enum: STARTED,COMPLETED,FAILED,ABORTED

successEventsinteger
tenantIdstring?
versionIdinteger
warningEventsinteger
Response
Copy

Get span-job associations for a run

Returns the mapping between spans and jobs within the specified pipeline run. Useful for understanding which jobs produced which spans.

Auth
Path Params
runIdstring

Pipeline run ID

GET /torch-pipeline/api/pipelines/runs/{runId}/span-job-associations
Copy
Responses
200

Span-job association mappings

SpanJobAssociationsResponseobject
associationsarray[object]
idinteger
jobUidstring
resultstring

Enum: SUCCESS,WARNING,ERROR,SKIPPED

runIdinteger
spanUidstring
metaobject
countinteger
pageinteger
sizeinteger
404

Pipeline run not found

Response
Copy

Get a pipeline run

Returns details of a specific pipeline run.

Auth
Path Params
identifierstring

Pipeline run ID

GET /torch-pipeline/api/pipelines/runs/{identifier}
Responses
200

Pipeline run details

PipelineRunRequestobject
runobject
argsobject?
*object
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
continuationIdstring?
errorEventsinteger
externalRunIdstring?
finishedAt
DateTimeobject
idinteger
pipelineIdinteger
resultstring

Enum: RUNNING,SUCCESS,FAILURE,CANCELLED

startedAt
DateTimeobject
statusstring

Enum: STARTED,COMPLETED,FAILED,ABORTED

successEventsinteger
tenantIdstring?
versionIdinteger
warningEventsinteger
404

Pipeline run not found

Response

Get latest pipeline run

Returns the most recent run for the specified pipeline.

Auth
Path Params
idstring

Pipeline ID

GET /torch-pipeline/api/pipelines/{id}/latestRun
Responses
200

Latest pipeline run

PipelineRunRequestobject
runobject
argsobject?
*object
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
continuationIdstring?
errorEventsinteger
externalRunIdstring?
finishedAt
DateTimeobject
idinteger
pipelineIdinteger
resultstring

Enum: RUNNING,SUCCESS,FAILURE,CANCELLED

startedAt
DateTimeobject
statusstring

Enum: STARTED,COMPLETED,FAILED,ABORTED

successEventsinteger
tenantIdstring?
versionIdinteger
warningEventsinteger
404

No runs found for the pipeline

Response

List runs for a pipeline

Returns a paginated list of runs for the specified pipeline.

Auth
Path Params
idstring

Pipeline ID

Query String
pagestring

Page number (0-based)

sizestring

Number of items per page

sortstring

Sort field and direction

GET /torch-pipeline/api/pipelines/{id}/runs
Responses
200

Paginated list of pipeline runs

PipelineRunsResponseobject
metaobject
countinteger
pageinteger
sizeinteger
runsarray[object]
argsobject?
*object
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
continuationIdstring?
errorEventsinteger
externalRunIdstring?
finishedAt
DateTimeobject
idinteger
pipelineIdinteger
resultstring

Enum: RUNNING,SUCCESS,FAILURE,CANCELLED

startedAt
DateTimeobject
statusstring

Enum: STARTED,COMPLETED,FAILED,ABORTED

successEventsinteger
tenantIdstring?
versionIdinteger
warningEventsinteger
404

Pipeline not found

Response

Create a span for a pipeline run

Creates a new span within the specified pipeline run. A span represents a unit of work within the pipeline execution.

Auth
Path Params
runIdstring

Pipeline run ID

Request Body

Span definition with optional job associations

SpanRequestobject
associatedJobUidsarray[string]
spanobject
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
errorEventsinteger
finishedAt
DateTimeobject
idinteger
parentSpanIdinteger
pipelineRunIdinteger
startedAt
DateTimeobject
statusstring

Enum: INITIALIZED,STARTED,FINISHED,ERRORED,ABORTED,SKIPPED

successEventsinteger
totalTimeinteger
uidstring
warningEventsinteger
POST /torch-pipeline/api/pipelines/runs/{runId}/spans
Responses
200

Created span

SpanRequestobject
associatedJobUidsarray[string]
spanobject
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
errorEventsinteger
finishedAt
DateTimeobject
idinteger
parentSpanIdinteger
pipelineRunIdinteger
startedAt
DateTimeobject
statusstring

Enum: INITIALIZED,STARTED,FINISHED,ERRORED,ABORTED,SKIPPED

successEventsinteger
totalTimeinteger
uidstring
warningEventsinteger
404

Pipeline run not found

Response

List spans for a pipeline run

Returns all spans associated with the given pipeline run. When onlyRootSpan=true, returns only the root span.

Auth
Path Params
runIdstring

Pipeline run ID

Query String
onlyRootSpanstring

Return only root spans (default false)

GET /torch-pipeline/api/pipelines/runs/{runId}/spans
Responses
200

List of spans

SpansResponseobject
spansarray[object]
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
errorEventsinteger
finishedAt
DateTimeobject
idinteger
parentSpanIdinteger
pipelineRunIdinteger
startedAt
DateTimeobject
statusstring

Enum: INITIALIZED,STARTED,FINISHED,ERRORED,ABORTED,SKIPPED

successEventsinteger
totalTimeinteger
uidstring
warningEventsinteger
404

Pipeline run not found

Response

Get a span by identity

Returns a specific span within a pipeline run.

Auth
Path Params
runIdstring

Pipeline run ID

identitystring

Span identity (ID or name)

GET /torch-pipeline/api/pipelines/runs/{runId}/spans/{identity}
Responses
200

Span details

SpanRequestobject
associatedJobUidsarray[string]
spanobject
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
errorEventsinteger
finishedAt
DateTimeobject
idinteger
parentSpanIdinteger
pipelineRunIdinteger
startedAt
DateTimeobject
statusstring

Enum: INITIALIZED,STARTED,FINISHED,ERRORED,ABORTED,SKIPPED

successEventsinteger
totalTimeinteger
uidstring
warningEventsinteger
404

Span not found

Response

List child spans

Returns all child spans of the specified span.

Auth
Path Params
spanIdstring

Parent span ID

GET /torch-pipeline/api/pipelines/spans/{spanId}/childSpans
Responses
200

List of child spans

ChildSpanResponseobject
childSpansarray[object]
avgExecutionTime
BigDecimalobject
intValobject
signuminteger
magarray[object]
bitCountPlusOneinteger
bitLengthPlusOneinteger
lowestSetBitPlusTwointeger
firstNonzeroIntNumPlusTwointeger
scaleinteger
precisioninteger
stringCachestring
intCompactinteger
errorEventsinteger
finishedAt
DateTimeobject
idinteger
parentSpanIdinteger
pipelineRunIdinteger
startedAt
DateTimeobject
statusstring

Enum: INITIALIZED,STARTED,FINISHED,ERRORED,ABORTED,SKIPPED

successEventsinteger
totalTimeinteger
uidstring
warningEventsinteger
404

Span not found

Response

Create a span event

Records an event within the specified span. Events capture data points, metrics, or status changes during span execution.

Auth
Path Params
spanIdstring

Span ID

Request Body

Span event data

SpanEventRequestobject
eventobject
contextDataobject?
*object
createdAt
DateTimeobject
eventUidstring
logDatastring?
spanIdinteger
tenantIdstring?
POST /torch-pipeline/api/pipelines/spans/{spanId}/events
Responses
200

Created span event

SpanEventResponseobject
eventobject
alert
EventAlertObjectobject
alertSeveritystring?

Enum: LOW,MEDIUM,HIGH,CRITICAL

isIncidentRaisedboolean
contextDataobject?
*object
createdAt
DateTimeobject
eventUidstring
idinteger
metaobject?
*object
spanIdinteger
spanUidstring?
typestring

Enum: SUCCESS,WARNING,ERROR,SKIPPED

404

Span not found

Response

List events for a span

Returns all events recorded within the specified span.

Auth
Path Params
spanIdstring

Span ID

GET /torch-pipeline/api/pipelines/spans/{spanId}/events
Responses
200

List of span events

SpanEventsResponseobject
eventsarray[object]
alert
EventAlertObjectobject
alertSeveritystring?

Enum: LOW,MEDIUM,HIGH,CRITICAL

isIncidentRaisedboolean
contextDataobject?
*object
createdAt
DateTimeobject
eventUidstring
idinteger
metaobject?
*object
spanIdinteger
spanUidstring?
typestring

Enum: SUCCESS,WARNING,ERROR,SKIPPED

metaobject
countinteger
pageinteger
sizeinteger
404

Span not found

Response

Get span event log

Returns the detailed log output for a specific span event.

Auth
Path Params
spanEventIdstring

Span event ID

GET /torch-pipeline/api/pipelines/spans/events/{spanEventId}/log
Responses
200

Span event log content

No response body
Response

Get a pipeline node by ID

Returns details for a specific pipeline node (job or task).

Auth
Path Params
idstring

Node ID

GET /torch-pipeline/api/pipelines/nodes/{id}
Responses
200

Node details

NodeDetailsResponseobject
dataobject
nodeobject
alertsCountinteger
assetIdinteger
contextobject?
*object
createdViastring

Enum: PIPELINE_CREATION,MANUAL_ADDITION,QUERY_LOG_ANALYSIS,AUTO_DERIVED_ASSET,DEPENDS_ON_RELATION,CRAWLER_CREATION

descriptionstring?
idinteger
jobNodeMetricarray[object]
Metricobject
changenumber
denominatorinteger
namestring
typestring

Enum: COST,DURATION,RECORDS_PROCESSED,RELIABILITY

unitstring?
valuenumber
jobStatusstring?

Enum: SUCCESS,ERROR,ABORTED,RUNNING

meta
Metaobject
codeLocationstring?
ownerstring?
teamstring?
namestring?
parentIdinteger
pipelineIdinteger
reliabilityPolicySummaryarray[object]
PolicySummaryobject
abortedinteger
errorinteger
policyTypestring

Enum: DATA_QUALITY,RECONCILIATION,EQUALITY,DATA_DRIFT,SCHEMA_DRIFT,DATA_CADENCE,PROFILE_ANOMALY,AUTO_ANOMALY

successinteger
totalinteger
statusstring

Enum: ACTIVE,STALE,DELETED

typestring

Enum: ASSET,FUNCTIONAL

uidstring?
versionIdinteger
rulesarray[object]
idinteger
nodeIdinteger
ruleobject
additionalPersistedColumnsarray[string]
analyticsPipelineIdinteger
anomalyStrengthThresholdstring?

Enum: HIGH,MEDIUM,LOW

archivalReasonstring?
archivedboolean
autoCreatedboolean
autoRetriesinteger
autoRetryEnabledboolean
backingAssetsarray[object]
customQuerystring?
customTableAssetIdsarray[integer]
integerinteger
idinteger
marker
MarkerConfigobject
typestring
ruleIdinteger
tableAliasstring?
tableAssetIdinteger
tableAssetUidstring?
continueExecutionOnFailureboolean
createdAtobject
createdBystring?
deletionReasonstring?
descriptionstring?
enabledboolean
engineTypestring?

Enum: SPARK,JDBC_SQL,POD

executionSequenceinteger
executionTimeoutInMinutesinteger
filterstring?
idinteger
includeInQualityScoreboolean
isCompositeRuleboolean
isProtectedResourceboolean
jobSchedule
JobScheduleobject
backingAssetIdinteger
cronExpressionstring
enabledboolean
idinteger
marker
MarkerConfigobject
typestring
namestring?
scheduleTypestring
tenantIdstring?
timeZonestring
labelsarray[object]
Labelobject
keystring
labelTypestring?

Enum: ASSET,RULE,DQ_RULE_ITEM,RECONCILIATION_COLUMN_MAPPING,POLICY_TEMPLATE_MEASURE,USER_DEFINED_FUNCTION

valuestring
lastUpdatedBystring?
leftCustomSqlConfig
CustomSqlConfigobject
columnMetadataListarray[object]
namestring
typestring
columnVariablesarray[object]
formatstring?
getOnlyWithVariableNameobject
isNumberboolean
namestring
valuestring?
queryTypestring
ruleVersioninteger
sanitizedQuerystring
sqlExpressionstring
tableAliasstring?
markedForDeletionboolean
markedForDeletionAtinteger
namestring
notificationChannels
NotificationPayloadobject
alertsEnabledboolean
configuredNotificationGroupIdsarray[integer]
notifyOnarray[string]

Enum: ERROR,WARNING,SUCCESS,ALL

notifyOnSuccessboolean
notifyOnWarningboolean
reNotifyFactorinteger
severitystring?

Enum: LOW,MEDIUM,HIGH,CRITICAL

tagsarray[string]
stringstring
parentIdinteger
policyGroupsarray[object]
PolicyGroupobject
createdAt
DateTimeobject
descriptionstring?
idinteger
namestring?
tenantIdstring?
updatedAt
DateTimeobject
policyScoreStrategystring

Enum: CUSTOM,WEIGHTAGE,RULES

policyTransformUDFSarray[object]
assetIdinteger
columnNamesarray[string]
stringstring
idinteger
namestring
parametersarray[object]
isColumnVariableboolean
keystring
valuestring?
ruleIdinteger
udfIdinteger
resourceStrategyTypestring?

Enum: INVENTORY,CUSTOM

rightCustomSqlConfig
CustomSqlConfigobject
columnMetadataListarray[object]
namestring
typestring
columnVariablesarray[object]
formatstring?
getOnlyWithVariableNameobject
isNumberboolean
namestring
valuestring?
queryTypestring
ruleVersioninteger
sanitizedQuerystring
sqlExpressionstring
tableAliasstring?
rightEngineTypestring?

Enum: SPARK,JDBC_SQL,POD

rightFilterstring?
rightSparkFilterSelectedColumnsarray[string]
stringstring
rightSparkSQLDynamicFilterVariableMapping
RuleSparkSQLDynamicFilterVariableMappingobject
mappingarray[object]
isColumnVariableboolean
keystring
valuestring?
ruleIdinteger
ruleNamestring
rightSparkSQLFilterTypestring

Enum: STATIC,DYNAMIC

ruleSetIdinteger
schedulestring?
scheduledboolean
segmentsarray[object]
ShortSegmentobject
idinteger
namestring?
typestring
selectedResourceInventorystring?
sparkFilterSelectedColumnsarray[string]
stringstring
sparkResourceConfig
SparkResourceConfigobject
additionalConfigurationobject?
*string
databricks
DataBricksSparkResourceConfigobject
clusterDriverTypestring?
clusterWorkerTypestring?
maxWorkersinteger
minWorkersinteger
dataproc
DataprocSparkResourceConfigobject
clusterMasterTypestring?
clusterWorkerTypestring?
numMasterNodesinteger
numWorkerNodesinteger
invalidFieldsarray[string]
livy
LivySparkResourceConfigobject
driverCoresinteger
driverMemorystring?
executorCoresinteger
executorMemorystring?
numExecutorsinteger
yunikorn
YunikornSparkResourceConfigobject
driverCoresinteger
driverLimitCoresstring?
driverMemorystring?
driverMemoryOverheadstring?
driverMemoryOverheadFactornumber
driverRequestCoresstring?
executorCoresinteger
executorLimitCoresstring?
executorMemorystring?
executorMemoryOverheadstring?
executorMemoryOverheadFactornumber
executorRequestCoresstring?
maxExecutorsinteger
minExecutorsinteger
sparkSQLDynamicFilterVariableMapping
RuleSparkSQLDynamicFilterVariableMappingobject
mappingarray[object]
isColumnVariableboolean
keystring
valuestring?
ruleIdinteger
ruleNamestring
sparkSQLFilterTypestring

Enum: STATIC,DYNAMIC

subTypestring?

Enum: ASSET,SQL

tagsarray[object]
RuleTagobject
idinteger
namestring
ruleIdinteger
tagIdinteger
tenantIdstring?
tenantIdstring?
thresholdLevel
AbsoluteThresholdConfigobject
config
AboveConfigsobject
directionstring

Enum: ABOVE,BELOW,RANGE,CHANGES_BY,DECREASED_BY,INCREASED_BY

successnumber
warningnumber
successnumber
typestring

Enum: ANOMALY,RELATIVE,TIME_BASED,ABSOLUTE

warningnumber
timeZonestring
totalExecutionTimeoutInMinutesinteger
treatZeroRowsAsSuccessboolean
typestring

Enum: DATA_QUALITY,RECONCILIATION,EQUALITY,DATA_DRIFT,SCHEMA_DRIFT,DATA_CADENCE,PROFILE_ANOMALY,AUTO_ANOMALY

updatedAtobject
versioninteger
404

Node not found

Response

Pipeline Tags

List all pipeline tags

Returns all tags used for categorizing pipelines and pipeline entities.

Auth
GET /torch-pipeline/api/tags
Responses
200

List of pipeline tags

No response body
Response

Create or update asset lineage

Creates or updates the lineage information for the specified asset.

Auth
Path Params
idstring

Asset ID

Request Body

Lineage data with upstream and downstream connections

PipelineLineageRequestobject
assetIdsarray[integer]
directionstring

Enum: UPSTREAM,DOWNSTREAM

process
ProcessDetailsobject
descriptionstring?
namestring
POST /torch-pipeline/api/assets/{id}/lineage
Responses
200

Updated lineage

LineageResponseobject
graphobject
edgesarray[object]
fromAssetTypestring?

Enum: ASSET,FUNCTIONAL

fromIdinteger
idinteger
toAssetTypestring?

Enum: ASSET,FUNCTIONAL

toIdinteger
versionIdinteger
nodesarray[object]
canAddDownstreamLineageboolean
canAddUpstreamLineageboolean
canDeleteboolean
functionalNodeGroupinteger
lineagestring?

Enum: UPSTREAM,DOWNSTREAM

nodeobject
alertsCountinteger
assetIdinteger
contextobject?
*object
createdViastring

Enum: PIPELINE_CREATION,MANUAL_ADDITION,QUERY_LOG_ANALYSIS,AUTO_DERIVED_ASSET,DEPENDS_ON_RELATION,CRAWLER_CREATION

descriptionstring?
idinteger
jobNodeMetricarray[object]
Metricobject
changenumber
denominatorinteger
namestring
typestring

Enum: COST,DURATION,RECORDS_PROCESSED,RELIABILITY

unitstring?
valuenumber
jobStatusstring?

Enum: SUCCESS,ERROR,ABORTED,RUNNING

meta
Metaobject
codeLocationstring?
ownerstring?
teamstring?
namestring?
parentIdinteger
pipelineIdinteger
reliabilityPolicySummaryarray[object]
PolicySummaryobject
abortedinteger
errorinteger
policyTypestring

Enum: DATA_QUALITY,RECONCILIATION,EQUALITY,DATA_DRIFT,SCHEMA_DRIFT,DATA_CADENCE,PROFILE_ANOMALY,AUTO_ANOMALY

successinteger
totalinteger
statusstring

Enum: ACTIVE,STALE,DELETED

typestring

Enum: ASSET,FUNCTIONAL

uidstring?
versionIdinteger
remainingColumnCountinteger
403

Insufficient permissions

Response

Get lineage for an asset

Returns the upstream and downstream lineage graph for the specified asset, showing data flow through pipelines and transformations.

Auth
Path Params
idstring

Asset ID

GET /torch-pipeline/api/assets/{id}/lineage
Responses
200

Asset lineage graph

LineageResponseobject
graphobject
edgesarray[object]
fromAssetTypestring?

Enum: ASSET,FUNCTIONAL

fromIdinteger
idinteger
toAssetTypestring?

Enum: ASSET,FUNCTIONAL

toIdinteger
versionIdinteger
nodesarray[object]
canAddDownstreamLineageboolean
canAddUpstreamLineageboolean
canDeleteboolean
functionalNodeGroupinteger
lineagestring?

Enum: UPSTREAM,DOWNSTREAM

nodeobject
alertsCountinteger
assetIdinteger
contextobject?
*object
createdViastring

Enum: PIPELINE_CREATION,MANUAL_ADDITION,QUERY_LOG_ANALYSIS,AUTO_DERIVED_ASSET,DEPENDS_ON_RELATION,CRAWLER_CREATION

descriptionstring?
idinteger
jobNodeMetricarray[object]
Metricobject
changenumber
denominatorinteger
namestring
typestring

Enum: COST,DURATION,RECORDS_PROCESSED,RELIABILITY

unitstring?
valuenumber
jobStatusstring?

Enum: SUCCESS,ERROR,ABORTED,RUNNING

meta
Metaobject
codeLocationstring?
ownerstring?
teamstring?
namestring?
parentIdinteger
pipelineIdinteger
reliabilityPolicySummaryarray[object]
PolicySummaryobject
abortedinteger
errorinteger
policyTypestring

Enum: DATA_QUALITY,RECONCILIATION,EQUALITY,DATA_DRIFT,SCHEMA_DRIFT,DATA_CADENCE,PROFILE_ANOMALY,AUTO_ANOMALY

successinteger
totalinteger
statusstring

Enum: ACTIVE,STALE,DELETED

typestring

Enum: ASSET,FUNCTIONAL

uidstring?
versionIdinteger
remainingColumnCountinteger
403

Insufficient permissions to view lineage

Response