API ReferenceFlows

Get flow version

GET /api/v1/flows/:flowId/versions/:version

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

flowIdstringRequiredformat: "uuid"
Flow ID
versionstringRequired
Version string

Response

Version details
publishedAtdatetime
Timestamp when this version was published
versionstring

Semantic version string (X.Y.Z)

botVersionstring or nullOptional
Bot runtime version used for this published version
changeSummaryobject or nullOptional

Top-level change summary stored in flow_versions.change_summary

definitionobject or nullOptional
Full transformed definition used by the bot runtime
flowDefinitionobject or nullOptional

The canonical flow definition — single source of truth for flow logic, shared by the API and the visual builder.

Visual nodes (LLM, TTS, STT, prompt, end_call) collapse into properties:

  • Service nodes -> services.*
  • Prompt nodes -> agent.prompt
  • Action nodes -> agent.functions[]
  • Edges are implicit — relationships expressed as data, not connections
notesstring or nullOptional
Changelog notes for this version
publishedBystring or nullOptionalformat: "uuid"
User ID of the person who published this version
publishedByNamestring or nullOptional
Display name of the user who published this version

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error