Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Name of the test case definition

response_engine
object
required

Response engine to use for the test case. Custom LLM is not supported.

user_prompt
string
required

User prompt to simulate in the test case

metrics
string[]
required

Array of metric names to evaluate

dynamic_variables
object

Dynamic variables to inject into the response engine

tool_mocks
object[]

Mock tool calls for testing

llm_model
enum<string>

LLM model to use for simulation

Available options:
gpt-4.1,
gpt-4.1-mini,
gpt-4.1-nano,
gpt-5,
gpt-5-mini,
gpt-5-nano,
gpt-5.1,
gpt-5.2,
gpt-5.4,
gpt-5.4-mini,
gpt-5.4-nano,
gpt-5.5,
claude-4.5-sonnet,
claude-4.6-sonnet,
claude-5-sonnet,
claude-4.5-haiku,
gemini-3.0-flash,
gemini-3.1-flash-lite,
gemini-3.5-flash

Response

Test case definition created successfully

name
string
required

Name of the test case definition

response_engine
object
required

Response engine to use for the test case. Custom LLM is not supported.

user_prompt
string
required

User prompt to simulate in the test case

metrics
string[]
required

Array of metric names to evaluate

dynamic_variables
object
required

Dynamic variables to inject into the response engine

tool_mocks
object[]
required

Mock tool calls for testing

llm_model
enum<string>
required

LLM model to use for simulation

Available options:
gpt-4.1,
gpt-4.1-mini,
gpt-4.1-nano,
gpt-5,
gpt-5-mini,
gpt-5-nano,
gpt-5.1,
gpt-5.2,
gpt-5.4,
gpt-5.4-mini,
gpt-5.4-nano,
gpt-5.5,
claude-4.5-sonnet,
claude-4.6-sonnet,
claude-5-sonnet,
claude-4.5-haiku,
gemini-3.0-flash,
gemini-3.1-flash-lite,
gemini-3.5-flash
test_case_definition_id
string
required

Unique identifier for the test case definition

type
enum<string>
required

Type of test case definition

Available options:
simulation
creation_timestamp
integer
required

Timestamp when the test case definition was created (milliseconds since epoch)

user_modified_timestamp
integer
required

Timestamp when the test case definition was last modified (milliseconds since epoch)