Skip to content
UltimateTeam.ai Docs

Preview Template

POST
/api/v1/workflows/templates/{template_id}/preview

Preview a template’s workflow definition without executing.

Returns the instantiated WorkflowDefinition with the given parameters, allowing the visual builder to load the template onto the canvas for customization before saving.

Authorizations

Parameters

Path Parameters

template_id
required
string

Request Body required

Request body for triggering a workflow template.

Attributes: params: Template-specific parameters. initial_input: Optional seed data for the first step.

object
initial_input
Any of:
object
key
additional properties
any
params
object
key
additional properties
any

Responses

200

Successful Response

object
key
additional properties
any

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string