Trigger Template

POST

/api/v1/workflows/templates/{template_id}/trigger

curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/workflows/templates/example/trigger \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "initial_input": {}, "params": {} }'

• Production
• Local development

Trigger execution of a workflow template.

Returns 202 immediately with a workflow run ID. The actual execution happens asynchronously in a background task.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

template_id

required

Template Id

string

Request Body^required

Media typeapplication/json

TriggerRequest

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

object

key

additional properties

any

null

null

params

Params

object

key

additional properties

any

Example^generated

{
  "initial_input": {},
  "params": {}
}

Responses

202

Successful Response

Media typeapplication/json

Response Trigger Template Api V1 Workflows Templates Template Id Trigger Post

object

key

additional properties

any

Example^generated

{}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}