Skip to main content
GET
Export a flow

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

id
string
required

Flow identifier.

Query Parameters

include_agents
boolean
default:true

When false, referenced agent rows are not inlined — only the flow definition is exported.

download
boolean
default:false

When true, sets a Content-Disposition attachment header so browsers offer a file save dialog.

Response

The portable flow export document.

Vendor-neutral, self-describing JSON export of a flow and the agents its nodes reference (anti-lock-in). Returned verbatim, not wrapped in the standard response envelope.

schema_version
string
Example:

"1.0.0"

kind
string
Example:

"orbit.flow.v1"

exported_at
string<date-time>
source
object
flow
object
agents
object[]

Referenced agent nodes, fully inlined (BYO-LLM model, prompt, tools, config) so the export is self-contained.