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

Steps

List Run Steps

get

Get run steps according to query filters.

Args: step_run_filter_model: Filter model used for pagination, sorting, filtering. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. auth_context: Authentication context.

Returns: The run steps according to query filters.

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
hydratebooleanOptionalDefault: 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
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
code_hashany of · nullableOptional
stringOptional
or
string[]Optional
cache_keyany of · nullableOptional
stringOptional
or
string[]Optional
statusany of · nullableOptional
stringOptional
or
string[]Optional
start_timeany of · nullableOptional
string · date-timeOptional
or
stringOptional
or
end_timeany of · nullableOptional
string · date-timeOptional
or
stringOptional
or
pipeline_run_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
snapshot_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
original_step_run_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
model_version_idany of · nullableOptional
string · uuidOptional
or
stringOptional
or
modelany of · nullableOptional
string · uuidOptional
or
stringOptional
or
versionany of · nullableOptional
integerOptional
or
stringOptional
or
exclude_retriedboolean · nullableOptional
cache_expires_atany of · nullableOptional
string · date-timeOptional
or
stringOptional
or
cache_expiredboolean · nullableOptional
Responses
200

Successful Response

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

Create Run Step

post

Create a run step.

Args: step: The run step to create.

Returns: The created run step.

Authorizations
OAuth2passwordRequired
Token URL:
Body

Request model for step runs.

userstring · uuid · nullableOptional
projectstring · uuidRequired
namestring · max: 255Required
start_timestring · date-timeRequired
end_timestring · date-time · nullableOptional
statusstring · enumRequired

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

Possible values:
cache_keystring · max: 255 · nullableOptional
cache_expires_atstring · date-time · nullableOptional
code_hashstring · max: 255 · nullableOptional
docstringstring · max: 65535 · nullableOptional
source_codestring · max: 65535 · nullableOptional
pipeline_run_idstring · uuidRequired
original_step_run_idstring · uuid · nullableOptional
parent_step_idsstring · uuid[]OptionalDeprecated
logsany of · nullableOptional
string · uuidOptional
or
resource_requesterstring · uuid · nullableOptional
Responses
200

Successful Response

application/json

Response model for step runs.

idstring · uuidRequired
permission_deniedbooleanOptionalDefault: false
namestring · max: 255Required
post/api/v1/steps

Get Step

get

Get one specific step.

Args: step_id: ID of the step to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The step.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
step_idstring · uuidRequired
Query parameters
hydratebooleanOptionalDefault: true
Responses
200

Successful Response

application/json

Response model for step runs.

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

Update Step

put

Updates a step.

Args: step_id: ID of the step. step_model: Step model to use for the update.

Returns: The updated step model.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
step_idstring · uuidRequired
Body

Update model for step runs.

statusstring · enum · nullableOptional

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

Possible values:
end_timestring · date-time · nullableOptional
cache_expires_atstring · date-time · nullableOptional
Responses
200

Successful Response

application/json

Response model for step runs.

idstring · uuidRequired
permission_deniedbooleanOptionalDefault: false
namestring · max: 255Required
put/api/v1/steps/{step_id}
ZenML Scarf

Last updated

Was this helpful?