--- title: "List Run Templates" method: GET path: "/api/v1/run_templates" tags: ["run_templates"] --- # List Run Templates `GET /api/v1/run_templates` Get a page of run templates. Args: 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. Returns: Page of run templates. ## 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 - `tag` string, nullable - `name` string, nullable - `workspace_id` union - string, uuid - string - `user_id` union - string, uuid - string - `pipeline_id` union - string, uuid - string - `build_id` union - string, uuid - string - `stack_id` union - string, uuid - string - `code_repository_id` union - string, uuid - string ## Response `200` Successful Response - PageRunTemplateResponse - `index` integer, required - `max_size` integer, required - `total_pages` integer, required - `total` integer, required - `items` RunTemplateResponse[], required - `body` RunTemplateResponseBody — Response body for run templates. - `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 - `runnable` boolean, required - `latest_run_id` string, uuid, nullable - `latest_run_status` 'initializing' | 'failed' | 'completed' | 'running' | 'cached' — Enum that represents the current status of a step or pipeline run. - `metadata` RunTemplateResponseMetadata — Response metadata for run templates. - `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 - `description` string, nullable - `pipeline_spec` PipelineSpecOutput — Specification of a pipeline. - `version` string - `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. - `parameters` object - `steps` StepSpecOutput[], required - `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 - `config_template` object, nullable - `config_schema` object, nullable - `resources` RunTemplateResponseResources — All resource models associated with the run template. - `source_deployment` PipelineDeploymentResponse — Response model for pipeline deployments. - `body` PipelineDeploymentResponseBody — Response body for pipeline deployments. - `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 - `metadata` PipelineDeploymentResponseMetadata — Response metadata for pipeline deployments. - `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 - `run_name_template` string, required - `pipeline_configuration` PipelineConfigurationOutput, required — Pipeline configuration class. - `enable_cache` boolean, nullable - `enable_artifact_metadata` boolean, nullable - `enable_artifact_visualization` boolean, nullable - `enable_step_logs` boolean, nullable - `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. - … - `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. - … - `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. - … - `parameters` object, nullable - `retry` StepRetryConfig — Retry configuration for a step. Delay is an integer (specified in seconds). - … - `name` string, required - `step_configurations` object - `client_environment` object - `client_version` string, nullable, required - `server_version` string, nullable, required - `pipeline_version_hash` string, nullable - `pipeline_spec` PipelineSpecOutput — Specification of a pipeline. - `version` string - `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. - … - `parameters` object - `steps` StepSpecOutput[], required - … - `code_path` string, nullable - `pipeline` PipelineResponse — Response model for pipelines. - `body` PipelineResponseBody — Response body for pipelines. - … - `metadata` PipelineResponseMetadata — Response metadata for pipelines. - … - `resources` PipelineResponseResources — Class for all resource models associated with the pipeline entity. - … - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `stack` StackResponse — Response model for stacks. - `body` StackResponseBody — Response body for stacks. - … - `metadata` StackResponseMetadata — Response metadata for stacks. - … - `resources` StackResponseResources — Class for all resource models associated with the stack entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `build` PipelineBuildResponse — Response model for pipeline builds. - `body` PipelineBuildResponseBody — Response body for pipeline builds. - … - `metadata` PipelineBuildResponseMetadata — Response metadata for pipeline builds. - … - `resources` PipelineBuildResponseResources — Class for all resource models associated with the pipeline build entity. - `id` string, uuid, required - `permission_denied` boolean - `schedule` ScheduleResponse — Response model for schedules. - `body` ScheduleResponseBody — Response body for schedules. - … - `metadata` ScheduleResponseMetadata — Response metadata for schedules. - … - `resources` ScheduleResponseResources — Class for all resource models associated with the schedule entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `code_reference` CodeReferenceResponse — Response model for code references. - `body` CodeReferenceResponseBody — Response body for code references. - … - `metadata` CodeReferenceResponseMetadata — Response metadata for code references. - `resources` CodeReferenceResponseResources — Class for all resource models associated with the code reference entity. - `id` string, uuid, required - `permission_denied` boolean - `template_id` string, uuid, nullable — Template used for the pipeline run. - `resources` PipelineDeploymentResponseResources — Class for all resource models associated with the pipeline deployment entity. - `triggers` PageTriggerResponse, required - `index` integer, required - `max_size` integer, required - `total_pages` integer, required - `total` integer, required - `items` TriggerResponse[], required - … - `id` string, uuid, required - `permission_denied` boolean - `pipeline` PipelineResponse — Response model for pipelines. - `body` PipelineResponseBody — Response body for pipelines. - `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 - `latest_run_id` string, uuid, nullable - `latest_run_status` 'initializing' | 'failed' | 'completed' | 'running' | 'cached' — Enum that represents the current status of a step or pipeline run. - `metadata` PipelineResponseMetadata — Response metadata for pipelines. - `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 - `resources` PipelineResponseResources — Class for all resource models associated with the pipeline entity. - `tags` TagResponse[], required - `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. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `build` PipelineBuildResponse — Response model for pipeline builds. - `body` PipelineBuildResponseBody — Response body for pipeline builds. - `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 - `metadata` PipelineBuildResponseMetadata — Response metadata for pipeline builds. - `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 - `pipeline` PipelineResponse — Response model for pipelines. - `body` PipelineResponseBody — Response body for pipelines. - … - `metadata` PipelineResponseMetadata — Response metadata for pipelines. - … - `resources` PipelineResponseResources — Class for all resource models associated with the pipeline entity. - … - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `stack` StackResponse — Response model for stacks. - `body` StackResponseBody — Response body for stacks. - … - `metadata` StackResponseMetadata — Response metadata for stacks. - … - `resources` StackResponseResources — Class for all resource models associated with the stack entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `images` object - `zenml_version` string, nullable - `python_version` string, nullable - `checksum` string, nullable - `stack_checksum` string, nullable - `is_local` boolean, required - `contains_code` boolean, required - `resources` PipelineBuildResponseResources — Class for all resource models associated with the pipeline build entity. - `id` string, uuid, required - `permission_denied` boolean - `code_reference` CodeReferenceResponse — Response model for code references. - `body` CodeReferenceResponseBody — Response body for code references. - `created` string, date-time, required - `updated` string, date-time, required - `commit` string, required — The commit of the code reference. - `subdirectory` string, required — The subdirectory of the code reference. - `code_repository` CodeRepositoryResponse, required — Response model for code repositories. - `body` CodeRepositoryResponseBody — Response body for code repositories. - … - `metadata` CodeRepositoryResponseMetadata — Response metadata for code repositories. - … - `resources` CodeRepositoryResponseResources — Class for all resource models associated with the code repository entity. - `id` string, uuid, required - `permission_denied` boolean - `name` string, required - `metadata` CodeReferenceResponseMetadata — Response metadata for code references. - `resources` CodeReferenceResponseResources — Class for all resource models associated with the code reference entity. - `id` string, uuid, required - `permission_denied` boolean - `tags` TagResponse[], required - `body` TagResponseBody — Response body for tags. - `created` string, date-time, required - `updated` string, date-time, required - `color` 'grey' | 'purple' | 'red' | 'green' | 'yellow' | 'orange' | 'lime' | 'teal' | 'turquoise' | 'magenta' | 'blue' — All possible color variants for frontend. - `tagged_count` integer, required — The count of resources tagged with this tag. - `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. - `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)