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

Runs

Deprecated

Create Template Run

post

Run a pipeline from a template.

Args: template_id: The ID of the template. config: Configuration for the pipeline run. auth_context: Authentication context.

Raises: ValueError: If the template can not be run.

Returns: The created pipeline run.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
template_idstring · uuidRequired
Body

Class for pipeline run configurations.

run_namestring · nullableOptional

The name of the pipeline run.

enable_cacheboolean · nullableOptional

Whether to enable cache for all steps of the pipeline run.

enable_artifact_metadataboolean · nullableOptional

Whether to enable metadata for the output artifacts of all steps of the pipeline run.

enable_artifact_visualizationboolean · nullableOptional

Whether to enable visualizations for the output artifacts of all steps of the pipeline run.

enable_step_logsboolean · nullableOptional

Whether to enable logs for all steps of the pipeline run.

enable_pipeline_logsboolean · nullableOptional

Whether to enable pipeline logs for the pipeline run.

enable_heartbeatboolean · nullableOptional

Whether to enable heartbeat for all steps of the pipeline run

buildany of · nullableOptional

The build to use for the pipeline run.

or
string · uuidOptional
execution_modestring · enum · nullableOptional

The execution mode for the pipeline run.

Possible values:
Responses
200

Successful Response

application/json

Response model for pipeline runs.

idstring · uuidRequired
permission_deniedbooleanOptionalDefault: false
namestring · max: 255Required
post/api/v1/run_templates/{template_id}/runs
ZenML Scarf

Last updated

Was this helpful?