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

# Retry a batch

> Requeues retry-eligible recipients (no-answer/busy, voicemail, or an
inconclusive/technical failure) back to pending: the API-key equivalent
of the dashboard's batch retry action. See POST /api/batch-calls/{id}/retry
for the full retry-eligibility rules.



## OpenAPI

````yaml /openapi.json post /api/v1/batches/{batch_id}/retry
openapi: 3.1.0
info:
  title: Eclatira API
  description: >-
    Programmatically create calls and batches, manage agents/tools/knowledge,
    and retrieve conversation analytics.
  contact:
    name: Eclatira Support
    email: contact@eclatira.com
  version: 1.0.0
servers:
  - url: https://app.eclatira.com
    description: API Server
security: []
tags:
  - name: developer-api
    description: >-
      The API-key-authenticated developer surface: calls, batches, and agents.
      Authenticate with `Authorization: Bearer ek_...`.
  - name: Calls
    description: Place outbound calls with an agent, check status, list history.
  - name: Batches
    description: 'Outbound call campaigns: create, list, inspect, cancel, retry.'
  - name: Agents
    description: Create and manage the agents that place and receive calls.
  - name: Tools
    description: Custom actions an agent can call mid-call, attached per-agent.
  - name: MCP Servers
    description: >-
      Connect an agent to an external MCP (Model Context Protocol) server so it
      can call that server's tools, with static or OAuth auth.
  - name: Knowledge Base
    description: Upload files and index them into an agent's knowledge base.
  - name: Realtime
    description: >-
      Mint a short-lived session token to open a live voice/video WebSocket
      connection: the only supported way for an API-key holder to authenticate
      into /ws/{user_id}.
  - name: Webhooks
    description: >-
      Register a durable callback URL to receive call.completed and
      batch.completed events for every matching workspace event, and fetch the
      tenant signing secret used to verify X-Webhook-Signature.
  - name: developer-api-keys
    description: >-
      Account-management routes (create/list/revoke API keys), authenticated via
      dashboard login, not an API key, since they mint the credentials the rest
      of the developer API uses.
paths:
  /api/v1/batches/{batch_id}/retry:
    post:
      tags:
        - Batches
        - developer-api
      summary: Retry a batch
      description: >-
        Requeues retry-eligible recipients (no-answer/busy, voicemail, or an

        inconclusive/technical failure) back to pending: the API-key equivalent

        of the dashboard's batch retry action. See POST
        /api/batch-calls/{id}/retry

        for the full retry-eligibility rules.
      operationId: retryBatch
      parameters:
        - name: batch_id
          in: path
          required: true
          schema:
            type: string
            title: Batch Id
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/BatchRetryRequest'
                - type: 'null'
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1BatchActionResponse'
        '403':
          description: >-
            A batch exists with this `batch_id`, but it belongs to a different
            tenant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '404':
          description: No batch exists with this `batch_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BatchRetryRequest:
      properties:
        scheduled_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Scheduled At
      type: object
      title: BatchRetryRequest
    V1BatchActionResponse:
      properties:
        status:
          type: string
          enum:
            - canceled
            - retry_scheduled
            - running
          title: Status
        scheduled_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Scheduled At
        eligible:
          anyOf:
            - type: integer
            - type: 'null'
          title: Eligible
        retried:
          anyOf:
            - type: integer
            - type: 'null'
          title: Retried
      type: object
      required:
        - status
      title: V1BatchActionResponse
      description: |-
        KNOWN IMPRECISION: this should be a discriminated union keyed on
        `status`, not one flat object with every non-status field optional.
        The OpenAPI schema currently can't express "scheduled_at and eligible
        only appear together with retry_scheduled; retried only appears with
        running"; every actual response still validates correctly, but a
        generated SDK's return type can't tell from the shape alone which
        fields accompany which status. Fine for now; revisit with a
        oneOf/discriminator (e.g. three response models keyed off `status`)
        if that ambiguity ever becomes an actual integration pain point rather
        than a theoretical one.

        Shared by both batch cancel and retry. Outcome -> populated fields:
        "canceled" (cancel; no extra fields), "retry_scheduled" (retry,
        scheduled for later; scheduled_at + eligible), "running" (retry, fired
        immediately; retried).
    V1ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/V1ErrorDetail'
      type: object
      required:
        - error
      title: V1ErrorResponse
      description: |-
        The error envelope every `developer-api`-tagged route returns for
        non-2xx responses, including `422`; this overrides FastAPI's default
        validation-error shape.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    V1ErrorDetail:
      properties:
        type:
          type: string
          title: Type
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
        param:
          anyOf:
            - type: string
            - type: 'null'
          title: Param
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
      type: object
      required:
        - type
        - code
        - message
      title: V1ErrorDetail
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        A long-lived, privileged API key (`ek_...` prefix), minted once from the
        dashboard. Intended for trusted server-side use only; never expose it in
        client-side code. Send as `Authorization: Bearer ek_...`. Required by
        every Calls, Batches, Agents, Tools, MCP Servers, Documents, and
        Realtime route.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.