Retell AI List Batch Tests API

The List Batch Tests API from Retell AI — 2 operation(s) for list batch tests.

Operations 2

GET /list-batch-tests #
GET /v2/list-batch-tests #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/retell-ai-list-batch-tests-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

retell-ai-list-batch-tests-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Retell SDK Add Community Voice List Batch Tests API
  version: 3.0.0
  contact:
    name: Retell Support
    url: https://www.retellai.com/
    email: support@retellai.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://api.retellai.com
  description: The production server.
security:
- api_key: []
tags:
- name: List Batch Tests
paths:
  /list-batch-tests:
    get:
      description: List batch test jobs for a response engine
      operationId: listBatchTests
      deprecated: true
      parameters:
      - in: query
        name: type
        schema:
          type: string
          enum:
          - retell-llm
          - conversation-flow
        required: true
        description: Type of response engine
      - in: query
        name: llm_id
        schema:
          type: string
        description: LLM ID (required when type is retell-llm)
      - in: query
        name: conversation_flow_id
        schema:
          type: string
        description: Conversation flow ID (required when type is conversation-flow)
      - in: query
        name: version
        schema:
          type: integer
        description: Version of the response engine (defaults to latest)
      responses:
        '200':
          description: Batch test jobs retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TestCaseBatchJob'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - List Batch Tests
  /v2/list-batch-tests:
    get:
      description: List batch test jobs with pagination
      operationId: listBatchTestsV2
      parameters:
      - in: query
        name: type
        schema:
          type: string
          enum:
          - retell-llm
          - conversation-flow
        required: true
        description: Type of response engine
      - in: query
        name: llm_id
        schema:
          type: string
        description: LLM ID (required when type is retell-llm)
      - in: query
        name: conversation_flow_id
        schema:
          type: string
        description: Conversation flow ID (required when type is conversation-flow)
      - in: query
        name: version
        schema:
          type: integer
        description: Version of the response engine (defaults to latest)
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/PaginationKeyParam'
      responses:
        '200':
          description: Batch test jobs retrieved successfully
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PaginatedResponseBase'
                - type: object
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/TestCaseBatchJob'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      tags:
      - List Batch Tests
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                - error
              message:
                type: string
                example: API key is missing or invalid.
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                - error
              message:
                type: string
                example: An unexpected server error occurred.
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                - error
              message:
                type: string
                example: Invalid request format, please check API reference.
    TooManyRequests:
      description: Too Many Requests
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                - error
              message:
                type: string
                example: Account rate limited, please throttle your requests.
  schemas:
    TestCaseBatchJob:
      type: object
      required:
      - test_case_batch_job_id
      - status
      - response_engine
      - pass_count
      - fail_count
      - error_count
      - total_count
      - creation_timestamp
      - user_modified_timestamp
      properties:
        test_case_batch_job_id:
          type: string
          description: Unique identifier for the test case batch job
        status:
          type: string
          enum:
          - in_progress
          - complete
          description: Status of the batch job
        response_engine:
          $ref: '#/components/schemas/ResponseEngine'
        pass_count:
          type: integer
          description: Number of test cases that passed
          minimum: 0
        fail_count:
          type: integer
          description: Number of test cases that failed
          minimum: 0
        error_count:
          type: integer
          description: Number of test cases that encountered errors
          minimum: 0
        total_count:
          type: integer
          description: Total number of test cases in the batch
          minimum: 0
        creation_timestamp:
          type: integer
          description: Timestamp when the batch job was created (milliseconds since epoch)
        user_modified_timestamp:
          type: integer
          description: Timestamp when the batch job was last modified (milliseconds since epoch)
    ResponseEngineCustomLm:
      type: object
      required:
      - type
      - llm_websocket_url
      properties:
        type:
          type: string
          enum:
          - custom-llm
          description: type of the Response Engine.
        llm_websocket_url:
          type: string
          description: LLM websocket url of the custom LLM.
    ResponseEngineRetellLm:
      type: object
      required:
      - type
      - llm_id
      properties:
        type:
          type: string
          enum:
          - retell-llm
          description: type of the Response Engine.
        llm_id:
          type: string
          description: id of the Retell LLM Response Engine.
        version:
          type:
          - number
          - 'null'
          example: 0
          description: Version of the Retell LLM Response Engine.
    PaginatedResponseBase:
      type: object
      properties:
        pagination_key:
          type: string
          description: Pagination key for the next page.
        has_more:
          type: boolean
          description: Whether more results are available.
    ResponseEngineConversationFlow:
      type: object
      required:
      - type
      - conversation_flow_id
      properties:
        type:
          type: string
          enum:
          - conversation-flow
          description: type of the Response Engine.
        conversation_flow_id:
          type: string
          description: ID of the Conversation Flow Response Engine.
        version:
          type:
          - number
          - 'null'
          example: 0
          description: Version of the Conversation Flow Response Engine.
    ResponseEngine:
      oneOf:
      - $ref: '#/components/schemas/ResponseEngineRetellLm'
      - $ref: '#/components/schemas/ResponseEngineCustomLm'
      - $ref: '#/components/schemas/ResponseEngineConversationFlow'
  parameters:
    PaginationKeyParam:
      in: query
      name: pagination_key
      schema:
        type: string
      description: Pagination key for fetching the next page.
    LimitParam:
      in: query
      name: limit
      schema:
        type: integer
        default: 50
        maximum: 1000
      description: Maximum number of items to return.
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
      bearerFormat: string
      description: Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"