Get Flow Template

GET

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

GET

/v1/agents/flow/templates/:id

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

1 {
2   "id": "3f7b1c20-9d4e-4a18-b6c2-8e0f1a2b3c4d",
3   "key": "string",
4   "name": "string",
5   "category": "string",
6   "graph": {
7     "version": {
8       "id": "9c1e8a40-3b2d-4f6a-8e11-2a7d5c9f0b34",
9       "agent_id": "agent_01k7m6etzwf057j6w0zmdsgppr",
10       "version": 1,
11       "is_active": true,
12       "is_draft": true,
13       "parent_version_id": "string",
14       "name": "string",
15       "notes": "string",
16       "published_by": "string",
17       "published_at": "2024-01-15T09:30:00Z",
18       "updated_at": "2024-01-15T09:30:00Z"
19     },
20     "nodes": [
21       {}
22     ],
23     "edges": [
24       {}
25     ],
26     "variables": [
27       {}
28     ]
29   },
30   "is_seed": true,
31   "created_at": "2024-01-15T09:30:00Z",
32   "updated_at": "2024-01-15T09:30:00Z",
33   "description": "string"
34 }

Retrieve a flow template by id.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The requested flow template.

idstring

Flow template id. A raw UUID, not a prefixed external id.

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