Steps
Get all steps for a given pipeline run.
Args: run_id: ID of the pipeline run. step_run_filter_model: Filter model used for pagination, sorting, filtering
Returns: The steps for a given pipeline run.
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
run_idstring · uuidRequired
Query parameters
sort_bystringOptionalDefault:
createdlogical_operatorstring · enumOptionalDefault:
Logical Ops to use to combine filters on list methods.
andPossible values: pageinteger · min: 1OptionalDefault:
1sizeinteger · min: 1 · max: 10000OptionalDefault:
20idany ofOptional
string · uuidOptional
stringOptional
nullOptional
createdany ofOptional
string · date-timeOptional
stringOptional
nullOptional
updatedany ofOptional
string · date-timeOptional
stringOptional
nullOptional
run_metadataany ofOptional
string[]Optional
nullOptional
scope_userany ofOptional
string · uuidOptional
nullOptional
userany ofOptional
string · uuidOptional
stringOptional
nullOptional
projectany ofOptional
string · uuidOptional
stringOptional
nullOptional
nameany ofOptional
stringOptional
nullOptional
code_hashany ofOptional
stringOptional
nullOptional
cache_keyany ofOptional
stringOptional
nullOptional
statusany ofOptional
stringOptional
nullOptional
start_timeany ofOptional
string · date-timeOptional
stringOptional
nullOptional
end_timeany ofOptional
string · date-timeOptional
stringOptional
nullOptional
pipeline_run_idany ofOptional
string · uuidOptional
stringOptional
nullOptional
snapshot_idany ofOptional
string · uuidOptional
stringOptional
nullOptional
original_step_run_idany ofOptional
string · uuidOptional
stringOptional
nullOptional
model_version_idany ofOptional
string · uuidOptional
stringOptional
nullOptional
modelany ofOptional
string · uuidOptional
stringOptional
nullOptional
exclude_retriedany ofOptional
booleanOptional
nullOptional
cache_expires_atany ofOptional
string · date-timeOptional
stringOptional
nullOptional
cache_expiredany ofOptional
booleanOptional
nullOptional
Responses
200
Successful Response
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
422
Unprocessable Entity
application/json
get
/api/v1/runs/{run_id}/stepsGET /api/v1/runs/{run_id}/steps HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"index": 1,
"max_size": 1,
"total_pages": 1,
"total": 1,
"items": [
{
"body": {
"created": "2025-12-07T06:59:55.014Z",
"updated": "2025-12-07T06:59:55.014Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"status": "initializing",
"version": 1,
"is_retriable": true,
"start_time": "2025-12-07T06:59:55.014Z",
"end_time": "2025-12-07T06:59:55.014Z",
"latest_heartbeat": "2025-12-07T06:59:55.014Z",
"model_version_id": "123e4567-e89b-12d3-a456-426614174000",
"substitutions": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"metadata": {
"config": {
"enable_cache": true,
"enable_artifact_metadata": true,
"enable_artifact_visualization": true,
"enable_step_logs": true,
"step_operator": true,
"experiment_tracker": true,
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"settings": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"environment": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"secrets": [
"123e4567-e89b-12d3-a456-426614174000"
],
"extra": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"failure_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"success_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"model": {
"name": "text",
"license": "text",
"description": "text",
"audience": "text",
"use_cases": "text",
"limitations": "text",
"trade_offs": "text",
"ethics": "text",
"tags": [
"text"
],
"version": "none",
"save_models_to_registry": true,
"model_version_id": "123e4567-e89b-12d3-a456-426614174000",
"suppress_class_validation_warnings": false
},
"retry": {
"max_retries": 1,
"delay": 0,
"backoff": 0
},
"substitutions": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cache_policy": {
"include_step_code": true,
"include_step_parameters": true,
"include_artifact_values": true,
"include_artifact_ids": true,
"ignored_inputs": [
"text"
],
"file_dependencies": [
"text"
],
"source_dependencies": [
{
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"cache_func": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"expires_after": 1
},
"runtime": "inline",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {
"materializer_source": [
{
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"default_materializer_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"artifact_config": {
"name": "text",
"version": 1,
"tags": [
"text"
],
"run_metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"artifact_type": "DataAnalysisArtifact"
}
}
},
"name": "text",
"template": "text",
"caching_parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"external_input_artifacts": {
"ANY_ADDITIONAL_PROPERTY": {
"id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"model_artifacts_or_metadata": {
"ANY_ADDITIONAL_PROPERTY": {
"model_name": "text",
"model_version": "text",
"artifact_name": "text",
"artifact_version": "text",
"metadata_name": "text"
}
},
"client_lazy_loaders": {
"ANY_ADDITIONAL_PROPERTY": {
"method_name": "text",
"call_chain": [
{
"attribute_name": "text",
"is_call": false,
"call_args": [],
"call_kwargs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"selector": null
}
],
"exclude_next_call": false
}
}
},
"spec": {
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"upstream_steps": [
"text"
],
"inputs": {
"ANY_ADDITIONAL_PROPERTY": {
"step_name": "text",
"output_name": "text"
}
},
"invocation_id": "text"
},
"cache_key": "text",
"cache_expires_at": "2025-12-07T06:59:55.014Z",
"code_hash": "text",
"docstring": "text",
"source_code": "text",
"exception_info": {
"traceback": "text",
"step_code_line": 1
},
"logs": {
"body": {
"created": "2025-12-07T06:59:55.014Z",
"updated": "2025-12-07T06:59:55.014Z",
"uri": "text",
"source": "text"
},
"metadata": {
"step_run_id": "123e4567-e89b-12d3-a456-426614174000",
"pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000",
"artifact_store_id": "123e4567-e89b-12d3-a456-426614174000"
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false
},
"snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
"pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000",
"original_step_run_id": "123e4567-e89b-12d3-a456-426614174000",
"parent_step_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"run_metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"resources": {
"user": {
"body": {
"created": "2025-12-07T06:59:55.014Z",
"updated": "2025-12-07T06:59:55.014Z",
"active": false,
"activation_token": "text",
"full_name": "",
"email_opted_in": true,
"is_service_account": true,
"is_admin": true,
"default_project_id": "123e4567-e89b-12d3-a456-426614174000",
"avatar_url": "text"
},
"metadata": {
"email": "",
"external_user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"model_version": "[Circular Reference]",
"inputs": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"outputs": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
}
]
}Last updated
Was this helpful?