For the complete documentation index, see llms.txt. This page is also available as Markdown.

Runs

List Runs

get

Get pipeline runs according to query filters.

Args: runs_filter_model: Filter model used for pagination, sorting, filtering. project_name_or_id: Optional name or ID of the project. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. include_full_metadata: Flag deciding whether to include the full metadata in the response.

Returns: The pipeline runs according to query filters.

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
project_name_or_idany of · nullableOptional
stringOptional
or
string · uuidOptional
hydratebooleanOptionalDefault: false
include_full_metadatabooleanOptionalDefault: false
sort_bystringOptionalDefault: created
logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:
pageinteger · min: 1OptionalDefault: 1
sizeinteger · min: 1 · max: 10000OptionalDefault: 20
idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
createdany of · nullableOptional
string · date-timeOptional
or
stringOptional
or
updatedany of · nullableOptional
string · date-timeOptional
or
stringOptional
or
run_metadataany of · nullableOptional
stringOptional
or
string[]Optional
tagsany of · nullableOptional
stringOptional
or
string[]Optional
scope_userstring · uuid · nullableOptional
userany of · nullableOptional
string · uuidOptional
or
stringOptional
or
projectany of · nullableOptional
string · uuidOptional
or
stringOptional
nameany of · nullableOptional
stringOptional
or
string[]Optional
indexany of · nullableOptional
integerOptional
or
stringOptional
or
orchestrator_run_idany of · nullableOptional
stringOptional
or
string[]Optional
pipeline_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
stack_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
schedule_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
build_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
snapshot_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
code_repository_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
template_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
source_snapshot_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
model_version_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
linked_to_model_version_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
statusany of · nullableOptional
stringOptional
or
string[]Optional
in_progressboolean · nullableOptional
start_timeany of · nullableOptional
string · date-timeOptional
or
stringOptional
or
end_timeany of · nullableOptional
string · date-timeOptional
or
stringOptional
or
pipeline_nameany of · nullableOptional
stringOptional
or
string[]Optional
pipelineany of · nullableOptional
string · uuidOptional
or
stringOptional
or
stackany of · nullableOptional
string · uuidOptional
or
stringOptional
or
code_repositoryany of · nullableOptional
string · uuidOptional
or
stringOptional
or
modelany of · nullableOptional
string · uuidOptional
or
stringOptional
or
stack_componentany of · nullableOptional
string · uuidOptional
or
stringOptional
or
templatableboolean · nullableOptional
triggered_by_step_run_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
triggered_by_deployment_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
trigger_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
parent_run_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
root_runs_onlyboolean · nullableOptional
Responses
200

Successful Response

application/json
indexintegerRequired
max_sizeintegerRequired
total_pagesintegerRequired
totalintegerRequired
get/api/v1/runs

Get Run

get

Get a specific pipeline run using its ID.

Args: run_id: ID of the pipeline run to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. refresh_status: Flag deciding whether we should try to refresh the status of the pipeline run using its orchestrator. include_python_packages: Flag deciding whether to include the Python packages in the response. include_full_metadata: Flag deciding whether to include the full metadata in the response.

Returns: The pipeline run.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
run_idstring · uuidRequired
Query parameters
hydratebooleanOptionalDefault: true
refresh_statusbooleanOptionalDefault: false
include_python_packagesbooleanOptionalDefault: false
include_full_metadatabooleanOptionalDefault: false
Responses
200

Successful Response

application/json

Response model for pipeline runs.

idstring · uuidRequired
permission_deniedbooleanOptionalDefault: false
namestring · max: 255Required
get/api/v1/runs/{run_id}

Update Run

put

Updates a run.

Args: run_id: ID of the run. run_model: Run model to use for the update.

Returns: The updated run model.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
run_idstring · uuidRequired
Body

Pipeline run update model.

statusstring · enum · nullableOptional

Enum that represents the execution status of a step or pipeline run.

Possible values:
status_reasonstring · max: 255 · nullableOptional
orchestrator_run_idstring · nullableOptional
add_tagsstring[] · nullableOptional
remove_tagsstring[] · nullableOptional
Responses
200

Successful Response

application/json

Response model for pipeline runs.

idstring · uuidRequired
permission_deniedbooleanOptionalDefault: false
namestring · max: 255Required
put/api/v1/runs/{run_id}

Delete Run

delete

Deletes a run.

Args: run_id: ID of the run.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
run_idstring · uuidRequired
Responses
200

Successful Response

application/json
anyOptional
delete/api/v1/runs/{run_id}

No content

ZenML Scarf

Last updated

Was this helpful?