Get Flow Template

Beta

GET

https://api.speechify.ai/v1/agents/flow/templates/:flow_template_id

GET

/v1/agents/flow/templates/:flow_template_id

$ curl https://api.speechify.ai/v1/agents/flow/templates/tmpl_01arz3ndektsv4rrffq69g5fav \
>      -H "Authorization: Bearer <token>"

1 {
2   "id": "tmpl_01arz3ndektsv4rrffq69g5fav",
3   "key": "product_name",
4   "name": "Example name",
5   "category": "example",
6   "graph": {
7     "version": {
8       "id": "fver_01arz3ndektsv4rrffq69g5fav",
9       "agent_id": "agent_01k7m6etzwf057j6w0zmdsgppr",
10       "version": 1,
11       "is_active": true,
12       "is_draft": true,
13       "parent_version_id": "fver_01arz3ndektsv4rrffq69g5fav",
14       "name": "Example name",
15       "notes": "example",
16       "published_at": "2026-06-24T18:03:11Z",
17       "updated_at": "2026-06-24T18:03:11Z"
18     },
19     "nodes": [
20       {}
21     ],
22     "edges": [
23       {}
24     ],
25     "variables": [
26       {}
27     ]
28   },
29   "is_seed": true,
30   "created_at": "2026-06-24T18:03:11Z",
31   "updated_at": "2026-06-24T18:03:11Z",
32   "description": "Example description."
33 }

Retrieve a flow template by id.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

flow_template_idstringRequired

Flow template id (prefixed external id, tmpl_...).

Response headers

X-Request-IDstring

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an X-Request-ID request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an `X-Request-ID` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope.

Response

The requested flow template.

idstringformat: "^tmpl_[0-9a-hjkmnp-tv-z]{26}$"

Flow template id (prefixed external id, tmpl_...).

keystring

Stable unique key for the template.

namestring

categorystring

graphobject

A flow graph: an ordered set of typed nodes connected by edges, plus flow variables. The node, edge, and variable shapes are governed by the live JSON Schema at GET /v1/agents/flow/schema and are intentionally opaque here so this spec cannot drift from that authoritative definition.

is_seedboolean

True for platform-provided templates.

created_atdatetime

updated_atdatetime

descriptionstring

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response headers

Response

Errors