Use templates

Templates are pre-built flow blueprints. They have the same shape as a flow definition — inputs, variables, steps, webhooks — plus a category and tags for browsing. The template endpoints are public: no authentication required.

Browse templates

curl "$BASE_URL/flows/templates"

Filter by status or category:

curl "$BASE_URL/flows/templates?status=active&category=contact-center"

Query parameter	Description
`status`	`active`, `draft`, or `archived`
`category`	Category label, e.g. `contact-center`, `utils`
`limit` / `skip`	Pagination (default 50 / 0)

Fetch one template in full:

curl "$BASE_URL/flows/templates/tmpl_echo_demo"

The response carries everything a definition needs: name, description, category, tags, version, status, inputs, variables, steps, and webhooks.

Instantiate a definition from a template

Templates are read-only — to use one, copy its shape into a new definition of your own via POST /flows/definitions. Take the template’s inputs, variables, steps, and webhooks, then supply your own name and status:

TEMPLATE=$(curl -s "$BASE_URL/flows/templates/tmpl_echo_demo")

echo "$TEMPLATE" | jq '{
    name: "My flow from template",
    status: "active",
    inputs: .inputs,
    variables: .variables,
    steps: .steps,
    webhooks: .webhooks
  }' | curl -X POST "$BASE_URL/flows/definitions" \
    -H "X-API-Key: $GETDIALED_API_KEY" \
    -H "Content-Type: application/json" \
    -d @-

The new definition is yours to edit freely — name your own credential on each task, adjust parameters, and re-PUT as needed. Changes to the definition never affect the template.

Most templates that call external platforms leave the task’s credential unset. Create a credential first and set it on each task before activating.

Set "status": "draft" (or omit status) if you want to review and edit before the flow becomes triggerable — only active definitions can be triggered.

Getting Started

Core Concepts

Building Flows

Triggers & Streaming

Browse templates

Instantiate a definition from a template

Next steps

Build your first flow

Flow definitions

​Browse templates

​Instantiate a definition from a template

​Next steps

Build your first flow

Flow definitions

Browse templates

Instantiate a definition from a template

Next steps