> ## 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.

# Generate a journey graph from a prompt

> Turn a plain-English description of a customer journey into a structured node/edge graph the journey canvas can render unchanged and POST /api/v1/campaigns can persist. The graph is validated server-side so the canvas never receives an unrenderable definition, and an optional dry-run simulation estimates projected sends. Nothing is persisted. Returns 503 when no AI provider is configured and 422 when the generated graph fails validation.



## OpenAPI

````yaml /openapi.yaml post /api/v1/campaigns/journey/from-prompt
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/campaigns/journey/from-prompt:
    post:
      tags:
        - Campaigns
      summary: Generate a journey graph from a prompt
      description: >-
        Turn a plain-English description of a customer journey into a structured
        node/edge graph the journey canvas can render unchanged and POST
        /api/v1/campaigns can persist. The graph is validated server-side so the
        canvas never receives an unrenderable definition, and an optional
        dry-run simulation estimates projected sends. Nothing is persisted.
        Returns 503 when no AI provider is configured and 422 when the generated
        graph fails validation.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - intent
              properties:
                intent:
                  type: string
                  minLength: 8
                  maxLength: 4000
                  description: Plain-English description of the journey to build.
                available_channels:
                  type: array
                  items:
                    type: string
                    enum:
                      - sms
                      - rcs
                      - whatsapp
                      - email
                      - push
                      - voice
                  description: >-
                    Channels the tenant has connected. Only these get send
                    nodes; omit for the default set.
                tone:
                  type: string
                  maxLength: 120
                  description: Brand tone hint, e.g. `friendly`, `formal`, `urgent`.
            example:
              intent: >-
                Welcome new signups with WhatsApp, wait a day, send an email
                with tips, then an SMS check-in after 3 days.
              available_channels:
                - whatsapp
                - email
                - sms
              tone: friendly
      responses:
        '200':
          description: Generated journey draft (not persisted)
          content:
            application/json:
              schema:
                type: object
                description: Generated journey draft (not persisted)
                properties:
                  data:
                    type: object
                    properties:
                      draft:
                        type: object
                        additionalProperties: true
                        properties:
                          definition:
                            type: object
                            properties:
                              nodes:
                                type: array
                                items:
                                  type: object
                                  additionalProperties: true
                              edges:
                                type: array
                                items:
                                  type: object
                                  additionalProperties: true
                      simulation:
                        type:
                          - 'null'
                          - object
                        additionalProperties: true
                        description: >-
                          Optional dry-run estimate of projected sends for the
                          generated graph.
                      model:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: >-
                          Unique request identifier (also returned in
                          X-Request-Id header)
                      timestamp:
                        type: string
                        format: date-time
                        description: ISO 8601 UTC timestamp of the response
              example:
                data:
                  draft:
                    definition:
                      nodes: []
                      edges: []
                  simulation:
                    totalProjectedSends: 1240
                  model: claude-sonnet
                meta:
                  request_id: req_7c1e9a2b3f
                  timestamp: '2026-08-02T14:23:11.000Z'
components:
  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_*)

````