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

# Start campaign

> Starts a campaign. Campaign status must be DRAFT or PAUSED.



## OpenAPI

````yaml POST /v1/external/campaigns/{agent_id}/{campaign_id}/start
openapi: 3.0.3
info:
  title: Samora AI API
  description: >
    The Samora AI API lets you trigger immediate outbound calls and manage
    outbound campaigns through the Samora AI system. Use it to start calls with
    your AI agents, pass per-call context, create campaigns, add recipients, and
    manage campaign lifecycle from your server.


    **Authentication:** Every request must include your organization API key in
    the `X-API-Key` header. These APIs are intended for server-to-server
    integrations; do not expose your organization API key in browser or mobile
    clients.


    **Phone number format:** Destination numbers must be in E.164 format (e.g.
    `+919876543210`) and include the country code. The pattern is: `+` followed
    by 10-15 digits.


    **Call statuses:** When you fetch call details, `status` can be: `PENDING`,
    `TRIGGERED`, `ONGOING`, `CALL_FINISHED`, `UNANSWERED`, `REJECTED`.


    **Campaign statuses:** Campaign `status` can be: `DRAFT`, `SCHEDULED`,
    `IN_PROGRESS`, `PAUSED`, `FINISHED`, `FAILED`, `CANCELLED`.


    **Campaign lifecycle:** Recipients can be added only while a campaign is
    `DRAFT` or `PAUSED`. Campaigns can be started only from `DRAFT` or `PAUSED`,
    stopped only from `IN_PROGRESS`, and cancelled unless they are already
    `FINISHED`, `FAILED`, or `CANCELLED`.


    **Campaign API limits:** Request bodies are limited to 2 MiB. Campaign names
    can be up to 120 characters. List requests support `page_size` up to 100.
    Add recipients accepts up to 5000 phone numbers per request, and each
    recipient's `call_variables` can be up to 4 KiB.


    **Transcripts and recordings:** For finished calls, presigned URLs for
    transcript and recording are valid for 60 minutes.
  version: 1.0.0
  license:
    name: Proprietary
servers:
  - url: https://api.samora.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /v1/external/campaigns/{agent_id}/{campaign_id}/start:
    post:
      description: Starts a campaign. Campaign status must be DRAFT or PAUSED.
      parameters:
        - $ref: '#/components/parameters/AgentId'
        - $ref: '#/components/parameters/CampaignId'
      responses:
        '200':
          description: Campaign started successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignEnvelopeResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    AgentId:
      name: agent_id
      in: path
      required: true
      description: The UUID of the AI agent that owns the campaign.
      schema:
        type: string
        format: uuid
    CampaignId:
      name: campaign_id
      in: path
      required: true
      description: The UUID of the campaign.
      schema:
        type: string
        format: uuid
  schemas:
    CampaignEnvelopeResponse:
      type: object
      required:
        - message
        - data
      properties:
        message:
          type: string
        data:
          $ref: '#/components/schemas/Campaign'
      additionalProperties: false
    Campaign:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        agent_id:
          type: string
          format: uuid
        agent_name:
          type: string
          description: >-
            Agent name, included on responses that join campaign and agent
            details.
        status:
          $ref: '#/components/schemas/CampaignStatus'
        retry_config:
          $ref: '#/components/schemas/RetryConfig'
        call_stats:
          $ref: '#/components/schemas/CampaignCallStats'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      additionalProperties: false
    Error:
      type: object
      required:
        - message
      properties:
        message:
          type: string
          description: Error message.
      additionalProperties: false
    CampaignStatus:
      type: string
      enum:
        - DRAFT
        - SCHEDULED
        - IN_PROGRESS
        - PAUSED
        - FINISHED
        - FAILED
        - CANCELLED
    RetryConfig:
      type: object
      description: >-
        Optional retry behavior for campaign calls. Retries are attempted when a
        call ends with one of the statuses listed in `retry_on`.
      properties:
        max_retries:
          type: integer
          minimum: 1
          maximum: 5
          description: >-
            Maximum retry attempts per recipient call. Must be between 1 and 5
            when retry_config is provided.
        retry_delay_minutes:
          type: integer
          minimum: 1
          maximum: 1440
          description: >-
            Delay in minutes before each retry attempt. Must be between 1 and
            1440.
        retry_on:
          type: array
          description: Call statuses that should trigger a retry.
          minItems: 1
          maxItems: 4
          uniqueItems: true
          items:
            type: string
            enum:
              - UNANSWERED
              - REJECTED
              - VOICEMAIL
              - FAILED
      additionalProperties: false
      example:
        max_retries: 2
        retry_delay_minutes: 30
        retry_on:
          - UNANSWERED
          - REJECTED
          - VOICEMAIL
    CampaignCallStats:
      type: object
      properties:
        total:
          type: integer
        finished:
          type: integer
        pending:
          type: integer
        unanswered:
          type: integer
        failed:
          type: integer
        total_duration:
          type: string
          description: Human-readable total call duration.
      additionalProperties: false
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found or does not belong to your organization
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your unique organization API key. Required on all requests.

````