Get Agent Flow

GET

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

GET

/v1/agents/:id/flow

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

1 {
2   "history": [
3     {
4       "id": "9c1e8a40-3b2d-4f6a-8e11-2a7d5c9f0b34",
5       "agent_id": "agent_01k7m6etzwf057j6w0zmdsgppr",
6       "version": 1,
7       "is_active": true,
8       "is_draft": true,
9       "parent_version_id": "string",
10       "name": "string",
11       "notes": "string",
12       "published_by": "string",
13       "published_at": "2024-01-15T09:30:00Z",
14       "updated_at": "2024-01-15T09:30:00Z"
15     }
16   ],
17   "draft": {
18     "version": {
19       "id": "9c1e8a40-3b2d-4f6a-8e11-2a7d5c9f0b34",
20       "agent_id": "agent_01k7m6etzwf057j6w0zmdsgppr",
21       "version": 1,
22       "is_active": true,
23       "is_draft": true,
24       "parent_version_id": "string",
25       "name": "string",
26       "notes": "string",
27       "published_by": "string",
28       "published_at": "2024-01-15T09:30:00Z",
29       "updated_at": "2024-01-15T09:30:00Z"
30     },
31     "nodes": [
32       {}
33     ],
34     "edges": [
35       {}
36     ],
37     "variables": [
38       {}
39     ]
40   },
41   "active": {
42     "version": {
43       "id": "9c1e8a40-3b2d-4f6a-8e11-2a7d5c9f0b34",
44       "agent_id": "agent_01k7m6etzwf057j6w0zmdsgppr",
45       "version": 1,
46       "is_active": true,
47       "is_draft": true,
48       "parent_version_id": "string",
49       "name": "string",
50       "notes": "string",
51       "published_by": "string",
52       "published_at": "2024-01-15T09:30:00Z",
53       "updated_at": "2024-01-15T09:30:00Z"
54     },
55     "nodes": [
56       {}
57     ],
58     "edges": [
59       {}
60     ],
61     "variables": [
62       {}
63     ]
64   }
65 }

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

idstringRequired

Response

The draft graph, active graph, and version history.

historylist of objects

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