Publish Agent Flow | SpeechifyAI API

Publish the agent's draft graph as a new active flow version.

Authentication

AuthorizationBearer

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

Path parameters

agent_idstringRequired

Prefixed agent id.

Request

This endpoint expects an object.

notesstringOptional

Optional changelog note recorded on the published version.

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 newly published flow version.

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

Flow version id (prefixed external id, fver_...).

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

versioninteger

Monotonic revision number within the agent.

is_activeboolean

is_draftboolean

parent_version_idstring or nullformat: "^fver_[0-9a-hjkmnp-tv-z]{26}$"

Parent flow version id (prefixed external id, fver_...); null for the first version.

namestring

notesstring

published_atdatetime or null

updated_atdatetime

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error

$	curl -X POST https://api.speechify.ai/v1/agents/agent_01k7m6etzwf057j6w0zmdsgppr/flow/publish \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"notes": "example"
>	}'

1	{
2	"id": "fver_01arz3ndektsv4rrffq69g5fav",
3	"agent_id": "agent_01k7m6etzwf057j6w0zmdsgppr",
4	"version": 1,
5	"is_active": true,
6	"is_draft": true,
7	"parent_version_id": "fver_01arz3ndektsv4rrffq69g5fav",
8	"name": "Example name",
9	"notes": "example",
10	"published_at": "2026-06-24T18:03:11Z",
11	"updated_at": "2026-06-24T18:03:11Z"
12	}