Get Agent Flow

Beta

GET

https://api.speechify.ai/v1/agents/:agent_id/flow

GET

/v1/agents/:agent_id/flow

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

1 {
2   "draft": {
3     "version": {
4       "id": "fver_01arz3ndektsv4rrffq69g5fav",
5       "agent_id": "agent_01k7m6etzwf057j6w0zmdsgppr",
6       "version": 1,
7       "is_active": true,
8       "is_draft": true,
9       "parent_version_id": "fver_01arz3ndektsv4rrffq69g5fav",
10       "name": "Example name",
11       "notes": "example",
12       "published_at": "2026-06-24T18:03:11Z",
13       "updated_at": "2026-06-24T18:03:11Z"
14     },
15     "nodes": [
16       {}
17     ],
18     "edges": [
19       {}
20     ],
21     "variables": [
22       {}
23     ]
24   },
25   "active": {
26     "version": {
27       "id": "fver_01arz3ndektsv4rrffq69g5fav",
28       "agent_id": "agent_01k7m6etzwf057j6w0zmdsgppr",
29       "version": 1,
30       "is_active": true,
31       "is_draft": true,
32       "parent_version_id": "fver_01arz3ndektsv4rrffq69g5fav",
33       "name": "Example name",
34       "notes": "example",
35       "published_at": "2026-06-24T18:03:11Z",
36       "updated_at": "2026-06-24T18:03:11Z"
37     },
38     "nodes": [
39       {}
40     ],
41     "edges": [
42       {}
43     ],
44     "variables": [
45       {}
46     ]
47   }
48 }

Return the agent’s flow graph: the current draft (if any), the active published graph (if any), and the version history.

Authentication

AuthorizationBearer

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

Path parameters

agent_idstringRequired

Prefixed agent id.

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 draft graph, active graph, and version history.

draftobject

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.

activeobject

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response headers

Response

Errors