> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Export a flow

> Download a portable, vendor-neutral JSON export of a flow and (by default) every agent its nodes reference — model, prompt, tools, and configuration inlined — so the work can be moved to another platform without a migration project. The document is returned verbatim, not wrapped in the standard response envelope.



## OpenAPI

````yaml /openapi.yaml get /api/v1/flows/{id}/export
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/flows/{id}/export:
    get:
      tags:
        - Flows
      summary: Export a flow
      description: >-
        Download a portable, vendor-neutral JSON export of a flow and (by
        default) every agent its nodes reference — model, prompt, tools, and
        configuration inlined — so the work can be moved to another platform
        without a migration project. The document is returned verbatim, not
        wrapped in the standard response envelope.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: Flow identifier.
        - in: query
          name: include_agents
          required: false
          schema:
            type: boolean
            default: true
          description: >-
            When `false`, referenced agent rows are not inlined — only the flow
            definition is exported.
        - in: query
          name: download
          required: false
          schema:
            type: boolean
            default: false
          description: >-
            When `true`, sets a `Content-Disposition` attachment header so
            browsers offer a file save dialog.
      responses:
        '200':
          description: The portable flow export document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowPortableExport'
        '404':
          description: No flow exists with that ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    FlowPortableExport:
      type: object
      description: >-
        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.
      properties:
        schema_version:
          type: string
          example: 1.0.0
        kind:
          type: string
          example: orbit.flow.v1
        exported_at:
          type: string
          format: date-time
        source:
          type: object
          properties:
            platform:
              type: string
              example: orbit-cpaas
            type:
              type: string
              example: flow
        flow:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            description:
              type: string
              nullable: true
            trigger_type:
              type: string
            cron_expr:
              type: string
              nullable: true
            cron_tz:
              type: string
              nullable: true
            status:
              type: string
            version:
              type: integer
              nullable: true
            definition:
              type: object
        agents:
          type: array
          description: >-
            Referenced agent nodes, fully inlined (BYO-LLM model, prompt, tools,
            config) so the export is self-contained.
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              description:
                type: string
                nullable: true
              type:
                type: string
              model:
                type: string
              system_prompt:
                type: string
                nullable: true
              temperature:
                type: number
                nullable: true
              max_tokens:
                type: integer
                nullable: true
              tools:
                type: array
                items:
                  type: object
                description: Tool definitions available to the agent.
              knowledge_base_ids:
                type: array
                items:
                  type: string
              config:
                type: object
    ErrorEnvelope:
      type: object
      required:
        - error
        - meta
      additionalProperties: false
      properties:
        error:
          type: object
          required:
            - code
            - message
            - status
          additionalProperties: false
          properties:
            code:
              type: string
            message:
              type: string
            status:
              type: integer
            details:
              type: object
              nullable: true
              additionalProperties: true
        meta:
          type: object
          required:
            - request_id
            - timestamp
          additionalProperties: false
          properties:
            request_id:
              type: string
              description: Unique request identifier (also returned as X-Request-Id header)
            timestamp:
              type: string
              format: date-time
            docs_url:
              type: string
              format: uri
              nullable: true
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````