--- title: "List Run Steps" method: GET path: "/api/v1/steps" tags: ["steps"] --- # List Run Steps `GET /api/v1/steps` 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. ## Query parameters - `hydrate` boolean - `sort_by` string - `logical_operator` 'or' | 'and' — Logical Ops to use to combine filters on list methods. - `page` integer - `size` integer - `id` union - string, uuid - string - `created` union - string, date-time - string - `updated` union - string, date-time - string - `scope_workspace` string, uuid, nullable - `name` string, nullable - `code_hash` string, nullable - `cache_key` string, nullable - `status` string, nullable - `start_time` union - string, date-time - string - `end_time` union - string, date-time - string - `pipeline_run_id` union - string, uuid - string - `original_step_run_id` union - string, uuid - string - `user_id` union - string, uuid - string - `workspace_id` union - string, uuid - string ## Response `200` Successful Response - PageStepRunResponse - `index` integer, required - `max_size` integer, required - `total_pages` integer, required - `total` integer, required - `items` StepRunResponse[], required - `body` StepRunResponseBody — Response body for step runs. - `created` string, date-time, required - `updated` string, date-time, required - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side. - `body` UserResponseBody — Response body for users. - `created` string, date-time, required - `updated` string, date-time, required - `active` boolean - `activation_token` string, nullable - `full_name` string - `email_opted_in` boolean, nullable — `null` if not answered, `true` if agreed, `false` if skipped. - `is_service_account` boolean, required - `is_admin` boolean, required - `metadata` UserResponseMetadata — Response metadata for users. - `email` string, nullable - `external_user_id` string, uuid, nullable - `user_metadata` object - `resources` UserResponseResources — Class for all resource models associated with the user entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `status` 'initializing' | 'failed' | 'completed' | 'running' | 'cached', required — Enum that represents the current status of a step or pipeline run. - `inputs` object - `outputs` object - `model_version_id` string, uuid, nullable - `metadata` StepRunResponseMetadata — Response metadata for step runs. - `workspace` WorkspaceResponse, required — Response model for workspaces. - `body` WorkspaceResponseBody — Response body for workspaces. - `created` string, date-time, required - `updated` string, date-time, required - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces. - `description` string - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `config` StepConfigurationOutput, required — Step configuration class. - `name` string, required - `enable_cache` boolean, nullable - `enable_artifact_metadata` boolean, nullable - `enable_artifact_visualization` boolean, nullable - `enable_step_logs` boolean, nullable - `step_operator` string, nullable - `experiment_tracker` string, nullable - `parameters` object - `settings` object - `extra` object - `failure_hook_source` Source — Source specification. A source specifies a module name as well as an optional attribute of that module. These values can be used to import the module and get the value of the attribute inside the module. Example: The source `Source(module="zenml.config.source", attribute="Source")` references the class that this docstring is describing. This class is defined in the `zenml.config.source` module and the name of the attribute is the class name `Source`. Attributes: module: The module name. attribute: Optional name of the attribute inside the module. type: The type of the source. - `module` string, required - `attribute` string, nullable - `type` 'user' | 'builtin' | 'internal' | 'distribution_package' | 'code_repository' | 'notebook' | 'unknown', required — Enum representing different types of sources. - `success_hook_source` Source — Source specification. A source specifies a module name as well as an optional attribute of that module. These values can be used to import the module and get the value of the attribute inside the module. Example: The source `Source(module="zenml.config.source", attribute="Source")` references the class that this docstring is describing. This class is defined in the `zenml.config.source` module and the name of the attribute is the class name `Source`. Attributes: module: The module name. attribute: Optional name of the attribute inside the module. type: The type of the source. - `module` string, required - `attribute` string, nullable - `type` 'user' | 'builtin' | 'internal' | 'distribution_package' | 'code_repository' | 'notebook' | 'unknown', required — Enum representing different types of sources. - `model` Model — Model class to pass into pipeline or step to set it into a model context. name: The name of the model. license: The license under which the model is created. description: The description of the model. audience: The target audience of the model. use_cases: The use cases of the model. limitations: The known limitations of the model. trade_offs: The tradeoffs of the model. ethics: The ethical implications of the model. tags: Tags associated with the model. version: The version name, version number or stage is optional and points model context to a specific version/stage. If skipped new version will be created. save_models_to_registry: Whether to save all ModelArtifacts to Model Registry, if available in active stack. model_version_id: The ID of a specific Model Version, if given - it will override `name` and `version` settings. Used mostly internally. - `name` string, required - `license` string, nullable - `description` string, nullable - `audience` string, nullable - `use_cases` string, nullable - `limitations` string, nullable - `trade_offs` string, nullable - `ethics` string, nullable - `tags` string[], nullable - `version` union - 'none' | 'staging' | 'production' | 'archived' | 'latest' — All possible stages of a Model Version. - integer - string - `save_models_to_registry` boolean - `model_version_id` string, uuid, nullable - `suppress_class_validation_warnings` boolean - `was_created_in_this_run` boolean - `retry` StepRetryConfig — Retry configuration for a step. Delay is an integer (specified in seconds). - `max_retries` integer - `delay` integer - `backoff` integer - `outputs` object - `caching_parameters` object - `external_input_artifacts` object - `model_artifacts_or_metadata` object - `client_lazy_loaders` object - `spec` StepSpecOutput, required — Specification of a pipeline. - `source` Source, required — Source specification. A source specifies a module name as well as an optional attribute of that module. These values can be used to import the module and get the value of the attribute inside the module. Example: The source `Source(module="zenml.config.source", attribute="Source")` references the class that this docstring is describing. This class is defined in the `zenml.config.source` module and the name of the attribute is the class name `Source`. Attributes: module: The module name. attribute: Optional name of the attribute inside the module. type: The type of the source. - `module` string, required - `attribute` string, nullable - `type` 'user' | 'builtin' | 'internal' | 'distribution_package' | 'code_repository' | 'notebook' | 'unknown', required — Enum representing different types of sources. - `upstream_steps` string[], required - `inputs` object - `pipeline_parameter_name` string - `cache_key` string, nullable - `code_hash` string, nullable - `docstring` string, nullable - `source_code` string, nullable - `start_time` string, date-time, nullable - `end_time` string, date-time, nullable - `logs` LogsResponse — Response model for logs. - `body` LogsResponseBody — Response body for logs. - `created` string, date-time, required - `updated` string, date-time, required - `uri` string, required - `metadata` LogsResponseMetadata — Response metadata for logs. - `step_run_id` union — When this is set, pipeline_run_id should be set to None. - string, uuid - string - `pipeline_run_id` union — When this is set, step_run_id should be set to None. - string, uuid - string - `artifact_store_id` union, required - string - string, uuid - `resources` LogsResponseResources — Class for all resource models associated with the Logs entity. - `id` string, uuid, required - `permission_denied` boolean - `deployment_id` string, uuid, required - `pipeline_run_id` string, uuid, required - `original_step_run_id` string, uuid, nullable - `parent_step_ids` string[] - `run_metadata` object - `resources` StepRunResponseResources — Class for all resource models associated with the step run entity. - `model_version` ModelVersionResponse — Response model for model versions. - `body` ModelVersionResponseBody — Response body for model versions. - `created` string, date-time, required - `updated` string, date-time, required - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side. - `body` UserResponseBody — Response body for users. - … - `metadata` UserResponseMetadata — Response metadata for users. - … - `resources` UserResponseResources — Class for all resource models associated with the user entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `stage` string, nullable — The stage of the model version - `number` integer, required — The number of the model version - `model` ModelResponse, required — Response model for models. - `body` ModelResponseBody — Response body for models. - … - `metadata` ModelResponseMetadata — Response metadata for models. - … - `resources` ModelResponseResources — Class for all resource models associated with the model entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `model_artifact_ids` object — Model artifacts linked to the model version - `data_artifact_ids` object — Data artifacts linked to the model version - `deployment_artifact_ids` object — Deployment artifacts linked to the model version - `pipeline_run_ids` object — Pipeline runs linked to the model version - `tags` TagResponse[] - `body` TagResponseBody — Response body for tags. - … - `metadata` BaseResponseMetadata — Base metadata model. Used as a base class for all metadata models associated with responses. - `resources` TagResponseResources — Class for all resource models associated with the tag entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required — The unique title of the tag. - `metadata` ModelVersionResponseMetadata — Response metadata for model versions. - `workspace` WorkspaceResponse, required — Response model for workspaces. - `body` WorkspaceResponseBody — Response body for workspaces. - … - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces. - … - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `description` string, nullable — The description of the model version - `run_metadata` object — Metadata linked to the model version - `resources` ModelVersionResponseResources — Class for all resource models associated with the model version entity. - `services` PageServiceResponse, required - `index` integer, required - `max_size` integer, required - `total_pages` integer, required - `total` integer, required - `items` ServiceResponse[], required - … - `id` string, uuid, required - `permission_denied` boolean - `name` string, nullable — The name of the model version - `id` string, uuid, required - `permission_denied` boolean - `name` string, required ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `422` — Unprocessable Entity --- [API](https://skmtc.net/zenml-io/apis/zenml-2.md) · [All operations](https://skmtc.net/zenml-io/apis/zenml-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zenml-io/zenml-2/versions/febb01b8bce3/schema)