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

# Suggest campaign copy with AI

> Generates first-pass campaign copy before the operator types anything, using the workspace's product catalog and its recent best-performing campaigns as context. Optionally pass a channel, tone, and free-text hint to bias the suggestions. Returns three subject lines, three body variations, and three call-to-action labels, plus the model used and a summary of the context it drew on. It does not create or persist a campaign. Returns 503 when no AI provider is configured and 504 if the model times out.



## OpenAPI

````yaml /openapi.yaml post /api/v1/campaigns/ai-brief/suggest
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/ai-brief/suggest:
    post:
      tags:
        - Campaigns
      summary: Suggest campaign copy with AI
      description: >-
        Generates first-pass campaign copy before the operator types anything,
        using the workspace's product catalog and its recent best-performing
        campaigns as context. Optionally pass a channel, tone, and free-text
        hint to bias the suggestions. Returns three subject lines, three body
        variations, and three call-to-action labels, plus the model used and a
        summary of the context it drew on. It does not create or persist a
        campaign. Returns 503 when no AI provider is configured and 504 if the
        model times out.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                channel:
                  type: string
                  enum:
                    - sms
                    - mms
                    - whatsapp
                    - email
                    - rcs
                    - viber
                    - voice
                    - push
                    - instagram
                    - messenger
                    - line
                    - telegram
                    - fax
                  description: >-
                    Target channel. Drives per-channel length caps and tone.
                    Omit for channel-agnostic suggestions.
                tone:
                  type: string
                  maxLength: 120
                  description: Tone hint, for example "playful", "formal", or "urgent".
                hint:
                  type: string
                  maxLength: 500
                  description: >-
                    Free-text steer, for example "holiday sale" or "new
                    arrivals".
            example:
              channel: email
              tone: friendly
              hint: back-to-school promo
      responses:
        '200':
          description: >-
            AI-generated subject, body, and CTA suggestions plus the context
            used.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      subject_suggestions:
                        type: array
                        items:
                          type: string
                      body_suggestions:
                        type: array
                        items:
                          type: string
                      cta_suggestions:
                        type: array
                        items:
                          type: string
                      context_used:
                        type: object
                        properties:
                          product_catalog_size:
                            type: integer
                          top_campaigns_count:
                            type: integer
                      model:
                        type: string
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '503':
          description: No AI provider is configured; type the brief manually.
        '504':
          description: The model timed out generating suggestions.
components:
  schemas:
    ResponseMeta:
      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_*)

````