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

# Create a batch generation job

> Submit multiple prompts at once for character renders or photo edits.



## OpenAPI

````yaml api-reference/openapi.json post /generation/batch
openapi: 3.1.0
info:
  version: 2.0.0
  title: Animus API
  description: >-
    Animus' API provides you with a variety of AI-driven capabilities. From
    generating text with our advanced large language models to creating
    customized content schedules, our API's applications are vast and versatile.

    Whether it's facilitating seamless conversation through predictive response
    or simulating a comprehensive content calendar, our advanced functionalities
    can cater to an array of feature requirements.
servers:
  - url: https://api.animusai.co/v2
security: []
paths:
  /generation/batch:
    post:
      tags:
        - Generation
      summary: Create a batch generation job
      description: Submit multiple prompts at once for character renders or photo edits.
      operationId: createGenerationBatch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchGenerationRequest'
      responses:
        '200':
          description: Batch submission accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchGenerationResponse'
        '400':
          description: The batch payload was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Insufficient credits or subscription access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    BatchGenerationRequest:
      type: object
      required:
        - prompts
      properties:
        prompts:
          type: array
          items:
            $ref: '#/components/schemas/BatchPromptRequest'
          minItems: 1
        character_id:
          type: string
        group_id:
          type: string
        group_title:
          type: string
    BatchGenerationResponse:
      type: object
      properties:
        batch_id:
          type: string
        group_id:
          type: string
        generation_type:
          type: string
        status:
          type: string
        message:
          type: string
        total_requested:
          type: integer
        successful_submissions:
          type: integer
        failed_submissions:
          type: integer
        estimated_time:
          type: integer
        credits_deducted:
          type: integer
        remaining_balance:
          type: integer
        results:
          type: array
          items:
            $ref: '#/components/schemas/BatchGenerationResult'
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Short error identifier.
        message:
          type: string
          description: Human readable error description.
        character_id:
          type: string
          description: Character that triggered the error, when relevant.
        group_id:
          type: string
          description: Group that triggered the error, when relevant.
    BatchPromptRequest:
      type: object
      required:
        - prompt
      properties:
        prompt:
          type: string
        face_swap:
          type: boolean
        use_face_lora:
          type: boolean
        use_body_lora:
          type: boolean
        source_image_url:
          type: string
          format: uri
    BatchGenerationResult:
      type: object
      properties:
        generation_id:
          type: string
        status:
          type: string
        prompt_index:
          type: integer
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````