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

# Get AI optimization suggestions for a campaign

> Analyzes the campaign's message copy (including every active A/B variant) and audience and returns AI-generated optimization suggestions: an optimal future `send_time`, two or three rewritten message `variants`, a `confidence` score, and a plain-language `rationale`. Use it from the composer to improve a draft before launch. The response discloses how it was produced — `source` is `llm` (with `model` and `token_usage`) or `heuristic` for the deterministic fallback when no model key is configured — and `variant_segments` gives per-variant SMS segment impact. Suggestions are advisory and never sent automatically. No request body is required.



## OpenAPI

````yaml /openapi.yaml post /api/v1/campaigns/{id}/optimize
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/{id}/optimize:
    post:
      tags:
        - Campaigns
      summary: Get AI optimization suggestions for a campaign
      description: >-
        Analyzes the campaign's message copy (including every active A/B
        variant) and audience and returns AI-generated optimization suggestions:
        an optimal future `send_time`, two or three rewritten message
        `variants`, a `confidence` score, and a plain-language `rationale`. Use
        it from the composer to improve a draft before launch. The response
        discloses how it was produced — `source` is `llm` (with `model` and
        `token_usage`) or `heuristic` for the deterministic fallback when no
        model key is configured — and `variant_segments` gives per-variant SMS
        segment impact. Suggestions are advisory and never sent automatically.
        No request body is required.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
      responses:
        '200':
          description: AI (or heuristic) optimization suggestions for the campaign.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      suggestions:
                        type: object
                        properties:
                          send_time:
                            type: string
                            format: date-time
                            description: >-
                              Suggested optimal UTC send time (always in the
                              future).
                          variants:
                            type: array
                            items:
                              type: string
                            description: Alternative message copy suggestions.
                          model:
                            type: string
                            description: >-
                              Model id used, or "heuristic" for the
                              deterministic fallback.
                          source:
                            type: string
                            enum:
                              - llm
                              - heuristic
                          token_usage:
                            type: object
                            description: >-
                              LLM token cost of this run; null on the heuristic
                              path.
                            properties:
                              prompt_tokens:
                                type: integer
                              completion_tokens:
                                type: integer
                              total_tokens:
                                type: integer
                          confidence:
                            type: number
                            description: 0-1 confidence in the suggestions.
                          rationale:
                            type: string
                          variant_segments:
                            type: array
                            description: >-
                              Per-variant SMS segment impact aligned by index
                              with variants; null entry for non-SMS channels.
                            items:
                              type: object
                              additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
        '404':
          description: Campaign not found.
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_*)

````