Skip to main content
GET
/
list-batch-tests
JavaScript
import Retell from 'retell-sdk';

const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
});

const batchTestResponses = await client.tests.listBatchTests({ type: 'retell-llm' });

console.log(batchTestResponses);
[
  {
    "test_case_batch_job_id": "<string>",
    "status": "in_progress",
    "response_engine": {
      "type": "retell-llm",
      "llm_id": "<string>",
      "version": 0
    },
    "pass_count": 1,
    "fail_count": 1,
    "error_count": 1,
    "total_count": 1,
    "creation_timestamp": 123,
    "user_modified_timestamp": 123
  }
]

Authorizations

​
Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Query Parameters

​
type
enum<string>
required

Type of response engine

Available options:
retell-llm,
conversation-flow
​
llm_id
string

LLM ID (required when type is retell-llm)

​
conversation_flow_id
string

Conversation flow ID (required when type is conversation-flow)

​
version
integer

Version of the response engine (defaults to latest)

Response

Batch test jobs retrieved successfully

​
test_case_batch_job_id
string
required

Unique identifier for the test case batch job

​
status
enum<string>
required

Status of the batch job

Available options:
in_progress,
complete
​
response_engine
object
required
​
pass_count
integer
required

Number of test cases that passed

Required range: x >= 0
​
fail_count
integer
required

Number of test cases that failed

Required range: x >= 0
​
error_count
integer
required

Number of test cases that encountered errors

Required range: x >= 0
​
total_count
integer
required

Total number of test cases in the batch

Required range: x >= 0
​
creation_timestamp
integer
required

Timestamp when the batch job was created (milliseconds since epoch)

​
user_modified_timestamp
integer
required

Timestamp when the batch job was last modified (milliseconds since epoch)