Create Flow Template | SpeechifyAI API

curl -X POST https://api.speechify.ai/v1/agents/flow/templates \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "key": "product_name",
  "name": "Example name",
  "graph": {
    "nodes": [
      {}
    ],
    "edges": [
      {}
    ],
    "variables": [
      {}
    ]
  },
  "description": "Example description.",
  "category": "example"
}'

{
  "id": "tmpl_01arz3ndektsv4rrffq69g5fav",
  "key": "product_name",
  "name": "Example name",
  "category": "example",
  "graph": {
    "version": {
      "id": "fver_01arz3ndektsv4rrffq69g5fav",
      "agent_id": "agent_01k7m6etzwf057j6w0zmdsgppr",
      "version": 1,
      "is_active": true,
      "is_draft": true,
      "parent_version_id": "fver_01arz3ndektsv4rrffq69g5fav",
      "name": "Example name",
      "notes": "example",
      "published_at": "2026-06-24T18:03:11Z",
      "updated_at": "2026-06-24T18:03:11Z"
    },
    "nodes": [
      {}
    ],
    "edges": [
      {}
    ],
    "variables": [
      {}
    ]
  },
  "is_seed": true,
  "created_at": "2026-06-24T18:03:11Z",
  "updated_at": "2026-06-24T18:03:11Z",
  "description": "Example description."
}

Create a reusable flow template from a graph.

Authentication

AuthorizationBearer

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

Headers

Speechify-VersionstringOptional

Request

This endpoint expects an object.

keystringRequired

namestringRequired

graphobjectRequired

Request-side flow graph: nodes, edges, and variables only. Unlike the response-side FlowGraph it carries no version block - the server owns version metadata.

descriptionstringOptional

categorystringOptional

Defaults to "custom" when omitted.

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 created 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

400

Bad Request Error

401

Unauthorized Error

409

Conflict Error

500

Internal Server Error