Run templates
Get a page of run templates.
Args: 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.
Returns: Page of run templates.
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
project_name_or_idany ofOptional
stringOptional
string · uuidOptional
nullOptional
hydratebooleanOptionalDefault:
falsesort_bystringOptionalDefault:
createdlogical_operatorstring · enumOptionalDefault:
Logical Ops to use to combine filters on list methods.
andPossible values: pageinteger · min: 1OptionalDefault:
1sizeinteger · min: 1 · max: 10000OptionalDefault:
20idany ofOptional
string · uuidOptional
stringOptional
nullOptional
createdany ofOptional
string · date-timeOptional
stringOptional
nullOptional
updatedany ofOptional
string · date-timeOptional
stringOptional
nullOptional
tagany ofOptional
stringOptional
nullOptional
tagsany ofOptional
string[]Optional
nullOptional
scope_userany ofOptional
string · uuidOptional
nullOptional
userany ofOptional
string · uuidOptional
stringOptional
nullOptional
projectany ofOptional
string · uuidOptional
stringOptional
nullOptional
nameany ofOptional
stringOptional
nullOptional
hiddenany ofOptional
booleanOptional
nullOptional
pipeline_idany ofOptional
string · uuidOptional
stringOptional
nullOptional
build_idany ofOptional
string · uuidOptional
stringOptional
nullOptional
stack_idany ofOptional
string · uuidOptional
stringOptional
nullOptional
code_repository_idany ofOptional
string · uuidOptional
stringOptional
nullOptional
pipelineany ofOptional
string · uuidOptional
stringOptional
nullOptional
stackany ofOptional
string · uuidOptional
stringOptional
nullOptional
Responses
200
Successful Response
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
422
Unprocessable Entity
application/json
get
/api/v1/run_templatesGET /api/v1/run_templates HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"index": 1,
"max_size": 1,
"total_pages": 1,
"total": 1,
"items": [
{
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"runnable": true,
"hidden": false
},
"metadata": {
"description": "text",
"pipeline_spec": {
"version": "0.5",
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"input_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"steps": [
{
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"upstream_steps": [
"text"
],
"inputs": {
"ANY_ADDITIONAL_PROPERTY": {
"step_name": "text",
"output_name": "text"
}
},
"invocation_id": "text"
}
],
"outputs": [
{
"step_name": "text",
"output_name": "text"
}
],
"output_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"config_template": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"config_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"user": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"active": false,
"activation_token": "text",
"full_name": "",
"email_opted_in": true,
"is_service_account": true,
"is_admin": true,
"default_project_id": "123e4567-e89b-12d3-a456-426614174000",
"avatar_url": "text"
},
"metadata": {
"email": "",
"external_user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"source_snapshot": "[Circular Reference]",
"pipeline": "[Circular Reference]",
"build": "[Circular Reference]",
"code_reference": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"commit": "text",
"subdirectory": "text",
"code_repository": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"logo_url": "text"
},
"metadata": {
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"description": "text"
},
"resources": {
"user": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"active": false,
"activation_token": "text",
"full_name": "",
"email_opted_in": true,
"is_service_account": true,
"is_admin": true,
"default_project_id": "123e4567-e89b-12d3-a456-426614174000",
"avatar_url": "text"
},
"metadata": {
"email": "",
"external_user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
}
},
"metadata": {},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false
},
"tags": [
{
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"color": "grey",
"exclusive": true
},
"metadata": {
"tagged_count": 1
},
"resources": {
"user": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"active": false,
"activation_token": "text",
"full_name": "",
"email_opted_in": true,
"is_service_account": true,
"is_admin": true,
"default_project_id": "123e4567-e89b-12d3-a456-426614174000",
"avatar_url": "text"
},
"metadata": {
"email": "",
"external_user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
}
],
"latest_run_id": "123e4567-e89b-12d3-a456-426614174000",
"latest_run_status": "initializing",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
}
]
}Get a run template.
Args: template_id: ID of the run template to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.
Returns: The run template.
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
template_idstring · uuidRequired
Query parameters
hydratebooleanOptionalDefault:
trueResponses
200
Successful Response
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
422
Unprocessable Entity
application/json
get
/api/v1/run_templates/{template_id}GET /api/v1/run_templates/{template_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"runnable": true,
"hidden": false
},
"metadata": {
"description": "text",
"pipeline_spec": {
"version": "0.5",
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"input_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"steps": [
{
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"upstream_steps": [
"text"
],
"inputs": {
"ANY_ADDITIONAL_PROPERTY": {
"step_name": "text",
"output_name": "text"
}
},
"invocation_id": "text"
}
],
"outputs": [
{
"step_name": "text",
"output_name": "text"
}
],
"output_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"config_template": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"config_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"user": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"active": false,
"activation_token": "text",
"full_name": "",
"email_opted_in": true,
"is_service_account": true,
"is_admin": true,
"default_project_id": "123e4567-e89b-12d3-a456-426614174000",
"avatar_url": "text"
},
"metadata": {
"email": "",
"external_user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"source_snapshot": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"runnable": true,
"deployable": true,
"is_dynamic": true
},
"metadata": {
"description": "text",
"run_name_template": "text",
"pipeline_configuration": {
"enable_cache": true,
"enable_artifact_metadata": true,
"enable_artifact_visualization": true,
"enable_step_logs": true,
"environment": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"secrets": [
"123e4567-e89b-12d3-a456-426614174000"
],
"enable_pipeline_logs": true,
"execution_mode": "continue_on_failure",
"settings": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"tags": [
"text"
],
"extra": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"failure_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"success_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"init_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"init_hook_kwargs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"cleanup_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"model": {
"name": "text",
"license": "text",
"description": "text",
"audience": "text",
"use_cases": "text",
"limitations": "text",
"trade_offs": "text",
"ethics": "text",
"tags": [
"text"
],
"version": "none",
"save_models_to_registry": true,
"model_version_id": "123e4567-e89b-12d3-a456-426614174000",
"suppress_class_validation_warnings": false
},
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"retry": {
"max_retries": 1,
"delay": 0,
"backoff": 0
},
"substitutions": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cache_policy": {
"include_step_code": true,
"include_step_parameters": true,
"include_artifact_values": true,
"include_artifact_ids": true,
"ignored_inputs": [
"text"
],
"file_dependencies": [
"text"
],
"source_dependencies": [
{
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"cache_func": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"expires_after": 1
},
"name": "text"
},
"step_configurations": {
"ANY_ADDITIONAL_PROPERTY": {
"spec": {
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"upstream_steps": [
"text"
],
"inputs": {
"ANY_ADDITIONAL_PROPERTY": {
"step_name": "text",
"output_name": "text"
}
},
"invocation_id": "text"
},
"config": {
"enable_cache": true,
"enable_artifact_metadata": true,
"enable_artifact_visualization": true,
"enable_step_logs": true,
"step_operator": true,
"experiment_tracker": true,
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"settings": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"environment": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"secrets": [
"123e4567-e89b-12d3-a456-426614174000"
],
"extra": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"failure_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"success_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"model": {
"name": "text",
"license": "text",
"description": "text",
"audience": "text",
"use_cases": "text",
"limitations": "text",
"trade_offs": "text",
"ethics": "text",
"tags": [
"text"
],
"version": "none",
"save_models_to_registry": true,
"model_version_id": "123e4567-e89b-12d3-a456-426614174000",
"suppress_class_validation_warnings": false
},
"retry": {
"max_retries": 1,
"delay": 0,
"backoff": 0
},
"substitutions": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cache_policy": {
"include_step_code": true,
"include_step_parameters": true,
"include_artifact_values": true,
"include_artifact_ids": true,
"ignored_inputs": [
"text"
],
"file_dependencies": [
"text"
],
"source_dependencies": [
{
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"cache_func": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"expires_after": 1
},
"runtime": "inline",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {
"materializer_source": [
{
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"default_materializer_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"artifact_config": {
"name": "text",
"version": 1,
"tags": [
"text"
],
"run_metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"artifact_type": "DataAnalysisArtifact"
}
}
},
"name": "text",
"template": "text",
"caching_parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"external_input_artifacts": {
"ANY_ADDITIONAL_PROPERTY": {
"id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"model_artifacts_or_metadata": {
"ANY_ADDITIONAL_PROPERTY": {
"model_name": "text",
"model_version": "text",
"artifact_name": "text",
"artifact_version": "text",
"metadata_name": "text"
}
},
"client_lazy_loaders": {
"ANY_ADDITIONAL_PROPERTY": {
"method_name": "text",
"call_chain": [
{
"attribute_name": "text",
"is_call": false,
"call_args": [],
"call_kwargs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"selector": null
}
],
"exclude_next_call": false
}
}
},
"step_config_overrides": {
"enable_cache": true,
"enable_artifact_metadata": true,
"enable_artifact_visualization": true,
"enable_step_logs": true,
"step_operator": true,
"experiment_tracker": true,
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"settings": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"environment": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"secrets": [
"123e4567-e89b-12d3-a456-426614174000"
],
"extra": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"failure_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"success_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"model": {
"name": "text",
"license": "text",
"description": "text",
"audience": "text",
"use_cases": "text",
"limitations": "text",
"trade_offs": "text",
"ethics": "text",
"tags": [
"text"
],
"version": "none",
"save_models_to_registry": true,
"model_version_id": "123e4567-e89b-12d3-a456-426614174000",
"suppress_class_validation_warnings": false
},
"retry": {
"max_retries": 1,
"delay": 0,
"backoff": 0
},
"substitutions": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cache_policy": {
"include_step_code": true,
"include_step_parameters": true,
"include_artifact_values": true,
"include_artifact_ids": true,
"ignored_inputs": [
"text"
],
"file_dependencies": [
"text"
],
"source_dependencies": [
{
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"cache_func": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"expires_after": 1
},
"runtime": "inline",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {
"materializer_source": [
{
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"default_materializer_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"artifact_config": {
"name": "text",
"version": 1,
"tags": [
"text"
],
"run_metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"artifact_type": "DataAnalysisArtifact"
}
}
},
"name": "text",
"template": "text",
"caching_parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"external_input_artifacts": {
"ANY_ADDITIONAL_PROPERTY": {
"id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"model_artifacts_or_metadata": {
"ANY_ADDITIONAL_PROPERTY": {
"model_name": "text",
"model_version": "text",
"artifact_name": "text",
"artifact_version": "text",
"metadata_name": "text"
}
},
"client_lazy_loaders": {
"ANY_ADDITIONAL_PROPERTY": {
"method_name": "text",
"call_chain": [
{
"attribute_name": "text",
"is_call": false,
"call_args": [],
"call_kwargs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"selector": null
}
],
"exclude_next_call": false
}
}
}
}
},
"client_environment": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"client_version": "text",
"server_version": "text",
"pipeline_version_hash": "text",
"pipeline_spec": {
"version": "0.5",
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"input_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"steps": [
{
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"upstream_steps": [
"text"
],
"inputs": {
"ANY_ADDITIONAL_PROPERTY": {
"step_name": "text",
"output_name": "text"
}
},
"invocation_id": "text"
}
],
"outputs": [
{
"step_name": "text",
"output_name": "text"
}
],
"output_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"code_path": "text",
"source_snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
"config_template": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"config_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": "[Circular Reference]",
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"pipeline": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000"
},
"metadata": {
"description": "text"
},
"resources": "[Circular Reference]",
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"build": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000"
},
"metadata": "[Circular Reference]",
"resources": {
"user": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"active": false,
"activation_token": "text",
"full_name": "",
"email_opted_in": true,
"is_service_account": true,
"is_admin": true,
"default_project_id": "123e4567-e89b-12d3-a456-426614174000",
"avatar_url": "text"
},
"metadata": {
"email": "",
"external_user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false
},
"code_reference": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"commit": "text",
"subdirectory": "text",
"code_repository": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"logo_url": "text"
},
"metadata": {
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"description": "text"
},
"resources": {
"user": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"active": false,
"activation_token": "text",
"full_name": "",
"email_opted_in": true,
"is_service_account": true,
"is_admin": true,
"default_project_id": "123e4567-e89b-12d3-a456-426614174000",
"avatar_url": "text"
},
"metadata": {
"email": "",
"external_user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
}
},
"metadata": {},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false
},
"tags": [
{
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"color": "grey",
"exclusive": true
},
"metadata": {
"tagged_count": 1
},
"resources": {
"user": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"active": false,
"activation_token": "text",
"full_name": "",
"email_opted_in": true,
"is_service_account": true,
"is_admin": true,
"default_project_id": "123e4567-e89b-12d3-a456-426614174000",
"avatar_url": "text"
},
"metadata": {
"email": "",
"external_user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
}
],
"latest_run_id": "123e4567-e89b-12d3-a456-426614174000",
"latest_run_status": "initializing",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
}Update a run template.
Args: template_id: ID of the run template to get. update: The updates to apply.
Returns: The updated run template.
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
template_idstring · uuidRequired
Body
Run template update model.
nameany ofOptional
string · max: 255Optional
nullOptional
descriptionany ofOptional
string · max: 65535Optional
nullOptional
hiddenany ofOptional
booleanOptional
nullOptional
add_tagsany ofOptional
string[]Optional
nullOptional
remove_tagsany ofOptional
string[]Optional
nullOptional
Responses
200
Successful Response
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
422
Unprocessable Entity
application/json
put
/api/v1/run_templates/{template_id}PUT /api/v1/run_templates/{template_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 93
{
"name": "text",
"description": "text",
"hidden": true,
"add_tags": [
"text"
],
"remove_tags": [
"text"
]
}{
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"runnable": true,
"hidden": false
},
"metadata": {
"description": "text",
"pipeline_spec": {
"version": "0.5",
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"input_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"steps": [
{
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"upstream_steps": [
"text"
],
"inputs": {
"ANY_ADDITIONAL_PROPERTY": {
"step_name": "text",
"output_name": "text"
}
},
"invocation_id": "text"
}
],
"outputs": [
{
"step_name": "text",
"output_name": "text"
}
],
"output_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"config_template": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"config_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"user": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"active": false,
"activation_token": "text",
"full_name": "",
"email_opted_in": true,
"is_service_account": true,
"is_admin": true,
"default_project_id": "123e4567-e89b-12d3-a456-426614174000",
"avatar_url": "text"
},
"metadata": {
"email": "",
"external_user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"source_snapshot": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"runnable": true,
"deployable": true,
"is_dynamic": true
},
"metadata": {
"description": "text",
"run_name_template": "text",
"pipeline_configuration": {
"enable_cache": true,
"enable_artifact_metadata": true,
"enable_artifact_visualization": true,
"enable_step_logs": true,
"environment": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"secrets": [
"123e4567-e89b-12d3-a456-426614174000"
],
"enable_pipeline_logs": true,
"execution_mode": "continue_on_failure",
"settings": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"tags": [
"text"
],
"extra": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"failure_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"success_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"init_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"init_hook_kwargs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"cleanup_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"model": {
"name": "text",
"license": "text",
"description": "text",
"audience": "text",
"use_cases": "text",
"limitations": "text",
"trade_offs": "text",
"ethics": "text",
"tags": [
"text"
],
"version": "none",
"save_models_to_registry": true,
"model_version_id": "123e4567-e89b-12d3-a456-426614174000",
"suppress_class_validation_warnings": false
},
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"retry": {
"max_retries": 1,
"delay": 0,
"backoff": 0
},
"substitutions": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cache_policy": {
"include_step_code": true,
"include_step_parameters": true,
"include_artifact_values": true,
"include_artifact_ids": true,
"ignored_inputs": [
"text"
],
"file_dependencies": [
"text"
],
"source_dependencies": [
{
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"cache_func": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"expires_after": 1
},
"name": "text"
},
"step_configurations": {
"ANY_ADDITIONAL_PROPERTY": {
"spec": {
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"upstream_steps": [
"text"
],
"inputs": {
"ANY_ADDITIONAL_PROPERTY": {
"step_name": "text",
"output_name": "text"
}
},
"invocation_id": "text"
},
"config": {
"enable_cache": true,
"enable_artifact_metadata": true,
"enable_artifact_visualization": true,
"enable_step_logs": true,
"step_operator": true,
"experiment_tracker": true,
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"settings": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"environment": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"secrets": [
"123e4567-e89b-12d3-a456-426614174000"
],
"extra": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"failure_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"success_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"model": {
"name": "text",
"license": "text",
"description": "text",
"audience": "text",
"use_cases": "text",
"limitations": "text",
"trade_offs": "text",
"ethics": "text",
"tags": [
"text"
],
"version": "none",
"save_models_to_registry": true,
"model_version_id": "123e4567-e89b-12d3-a456-426614174000",
"suppress_class_validation_warnings": false
},
"retry": {
"max_retries": 1,
"delay": 0,
"backoff": 0
},
"substitutions": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cache_policy": {
"include_step_code": true,
"include_step_parameters": true,
"include_artifact_values": true,
"include_artifact_ids": true,
"ignored_inputs": [
"text"
],
"file_dependencies": [
"text"
],
"source_dependencies": [
{
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"cache_func": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"expires_after": 1
},
"runtime": "inline",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {
"materializer_source": [
{
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"default_materializer_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"artifact_config": {
"name": "text",
"version": 1,
"tags": [
"text"
],
"run_metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"artifact_type": "DataAnalysisArtifact"
}
}
},
"name": "text",
"template": "text",
"caching_parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"external_input_artifacts": {
"ANY_ADDITIONAL_PROPERTY": {
"id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"model_artifacts_or_metadata": {
"ANY_ADDITIONAL_PROPERTY": {
"model_name": "text",
"model_version": "text",
"artifact_name": "text",
"artifact_version": "text",
"metadata_name": "text"
}
},
"client_lazy_loaders": {
"ANY_ADDITIONAL_PROPERTY": {
"method_name": "text",
"call_chain": [
{
"attribute_name": "text",
"is_call": false,
"call_args": [],
"call_kwargs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"selector": null
}
],
"exclude_next_call": false
}
}
},
"step_config_overrides": {
"enable_cache": true,
"enable_artifact_metadata": true,
"enable_artifact_visualization": true,
"enable_step_logs": true,
"step_operator": true,
"experiment_tracker": true,
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"settings": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"environment": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"secrets": [
"123e4567-e89b-12d3-a456-426614174000"
],
"extra": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"failure_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"success_hook_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"model": {
"name": "text",
"license": "text",
"description": "text",
"audience": "text",
"use_cases": "text",
"limitations": "text",
"trade_offs": "text",
"ethics": "text",
"tags": [
"text"
],
"version": "none",
"save_models_to_registry": true,
"model_version_id": "123e4567-e89b-12d3-a456-426614174000",
"suppress_class_validation_warnings": false
},
"retry": {
"max_retries": 1,
"delay": 0,
"backoff": 0
},
"substitutions": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"cache_policy": {
"include_step_code": true,
"include_step_parameters": true,
"include_artifact_values": true,
"include_artifact_ids": true,
"ignored_inputs": [
"text"
],
"file_dependencies": [
"text"
],
"source_dependencies": [
{
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"cache_func": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"expires_after": 1
},
"runtime": "inline",
"outputs": {
"ANY_ADDITIONAL_PROPERTY": {
"materializer_source": [
{
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"default_materializer_source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"artifact_config": {
"name": "text",
"version": 1,
"tags": [
"text"
],
"run_metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"artifact_type": "DataAnalysisArtifact"
}
}
},
"name": "text",
"template": "text",
"caching_parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"external_input_artifacts": {
"ANY_ADDITIONAL_PROPERTY": {
"id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"model_artifacts_or_metadata": {
"ANY_ADDITIONAL_PROPERTY": {
"model_name": "text",
"model_version": "text",
"artifact_name": "text",
"artifact_version": "text",
"metadata_name": "text"
}
},
"client_lazy_loaders": {
"ANY_ADDITIONAL_PROPERTY": {
"method_name": "text",
"call_chain": [
{
"attribute_name": "text",
"is_call": false,
"call_args": [],
"call_kwargs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"selector": null
}
],
"exclude_next_call": false
}
}
}
}
},
"client_environment": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"client_version": "text",
"server_version": "text",
"pipeline_version_hash": "text",
"pipeline_spec": {
"version": "0.5",
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"parameters": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"input_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"steps": [
{
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"upstream_steps": [
"text"
],
"inputs": {
"ANY_ADDITIONAL_PROPERTY": {
"step_name": "text",
"output_name": "text"
}
},
"invocation_id": "text"
}
],
"outputs": [
{
"step_name": "text",
"output_name": "text"
}
],
"output_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"code_path": "text",
"source_snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
"config_template": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"config_schema": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": "[Circular Reference]",
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"pipeline": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000"
},
"metadata": {
"description": "text"
},
"resources": "[Circular Reference]",
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"build": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000"
},
"metadata": "[Circular Reference]",
"resources": {
"user": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"active": false,
"activation_token": "text",
"full_name": "",
"email_opted_in": true,
"is_service_account": true,
"is_admin": true,
"default_project_id": "123e4567-e89b-12d3-a456-426614174000",
"avatar_url": "text"
},
"metadata": {
"email": "",
"external_user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false
},
"code_reference": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"commit": "text",
"subdirectory": "text",
"code_repository": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"source": {
"module": "text",
"attribute": "text",
"type": "user",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"logo_url": "text"
},
"metadata": {
"config": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"description": "text"
},
"resources": {
"user": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"active": false,
"activation_token": "text",
"full_name": "",
"email_opted_in": true,
"is_service_account": true,
"is_admin": true,
"default_project_id": "123e4567-e89b-12d3-a456-426614174000",
"avatar_url": "text"
},
"metadata": {
"email": "",
"external_user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
}
},
"metadata": {},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false
},
"tags": [
{
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"color": "grey",
"exclusive": true
},
"metadata": {
"tagged_count": 1
},
"resources": {
"user": {
"body": {
"created": "2025-11-12T18:21:27.717Z",
"updated": "2025-11-12T18:21:27.717Z",
"active": false,
"activation_token": "text",
"full_name": "",
"email_opted_in": true,
"is_service_account": true,
"is_admin": true,
"default_project_id": "123e4567-e89b-12d3-a456-426614174000",
"avatar_url": "text"
},
"metadata": {
"email": "",
"external_user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"resources": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
}
],
"latest_run_id": "123e4567-e89b-12d3-a456-426614174000",
"latest_run_status": "initializing",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "123e4567-e89b-12d3-a456-426614174000",
"permission_denied": false,
"name": "text"
}Delete a run template.
Args: template_id: ID of the run template to delete.
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
template_idstring · uuidRequired
Responses
200
Successful Response
application/json
Responseany
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
422
Unprocessable Entity
application/json
delete
/api/v1/run_templates/{template_id}DELETE /api/v1/run_templates/{template_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Last updated
Was this helpful?