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

# Create a guided agent script

> Creates a guided agent script from a name, optional channel targeting, and an optional step graph. Every branch option's next_step_id must resolve to a step_id within the same script (validated server-side; an unresolved reference or a duplicate step_id returns 422). Owner / admin only. Returns the created script with its assigned id and version 1.



## OpenAPI

````yaml /openapi.yaml post /api/v1/inbox/agent-scripts
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
paths:
  /api/v1/inbox/agent-scripts:
    post:
      tags:
        - Inbox
      summary: Create a guided agent script
      description: >-
        Creates a guided agent script from a name, optional channel targeting,
        and an optional step graph. Every branch option's next_step_id must
        resolve to a step_id within the same script (validated server-side; an
        unresolved reference or a duplicate step_id returns 422). Owner / admin
        only. Returns the created script with its assigned id and version 1.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  description: Human-readable script name (1–120 chars).
                description:
                  type: string
                  description: >-
                    Author-facing description (≤ 4000 chars). Send null to
                    clear.
                channels:
                  type: array
                  description: >-
                    Digital channels this script targets. Empty or omitted ⇒
                    every digital channel.
                  items:
                    type: string
                    enum:
                      - email
                      - web_chat
                      - whatsapp
                      - sms
                      - rcs
                      - viber
                      - instagram
                      - messenger
                      - line
                      - telegram
                      - apple_messages
                enabled:
                  type: boolean
                  description: >-
                    Whether the script is active in the agent console. Defaults
                    to true.
                start_step_id:
                  type: string
                  description: >-
                    step_id the console starts at. Defaults to the first step
                    when omitted.
                steps:
                  type: array
                  description: >-
                    The script's step graph (≤ 500 steps). Each step has a
                    step_id, kind (prompt | question | note | disposition),
                    body, and optional branch options pointing to the next
                    step_id.
                  items:
                    type: object
                    required:
                      - step_id
                      - body
                    properties:
                      step_id:
                        type: string
                        description: >-
                          Unique id for this step within the script (1–120
                          chars).
                      kind:
                        type: string
                        enum:
                          - prompt
                          - question
                          - note
                          - disposition
                        description: Step kind. Defaults to prompt.
                      title:
                        type: string
                        description: Optional short step title (≤ 200 chars).
                      body:
                        type: string
                        description: >-
                          The guidance the agent reads / follows at this step
                          (1–20000 chars).
                      options:
                        type: array
                        description: >-
                          Branch options (≤ 20). Picking one advances to
                          next_step_id; null ends the flow.
                        items:
                          type: object
                          required:
                            - label
                          properties:
                            label:
                              type: string
                              description: Option label shown to the agent (1–200 chars).
                            next_step_id:
                              type: string
                              description: >-
                                step_id to advance to when this option is
                                picked; null / omitted ends the flow.
      responses:
        '200':
          description: Default Response
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_*)

````