Create New Test Case

Create a new test case in a dataset.

POST /api/v1/simulation/datasets/{dataset_id}/test-cases

Create New Test Case

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/simulation/datasets/{dataset_id}/test-cases \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "question": "<string>",
  "expected_type": "answer",
  "expected_answer": "<string>",
  "expected_tool_name": "<string>",
  "expected_tool_args": {},
  "expected_agent_id": "<string>",
  "metadata": {},
  "persona_id": "<string>",
  "api_data_overrides": {},
  "tool_call_overrides": {},
  "steps": [
    {
      "user_message": "<string>",
      "step_order": 123,
      "expected_type": "answer",
      "expected_answer": "<string>",
      "expected_tool_name": "<string>",
      "expected_tool_args": {}
    }
  ]
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/simulation/datasets/{dataset_id}/test-cases"

payload = {
    "question": "<string>",
    "expected_type": "answer",
    "expected_answer": "<string>",
    "expected_tool_name": "<string>",
    "expected_tool_args": {},
    "expected_agent_id": "<string>",
    "metadata": {},
    "persona_id": "<string>",
    "api_data_overrides": {},
    "tool_call_overrides": {},
    "steps": [
        {
            "user_message": "<string>",
            "step_order": 123,
            "expected_type": "answer",
            "expected_answer": "<string>",
            "expected_tool_name": "<string>",
            "expected_tool_args": {}
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    question: '<string>',
    expected_type: 'answer',
    expected_answer: '<string>',
    expected_tool_name: '<string>',
    expected_tool_args: {},
    expected_agent_id: '<string>',
    metadata: {},
    persona_id: '<string>',
    api_data_overrides: {},
    tool_call_overrides: {},
    steps: [
      {
        user_message: '<string>',
        step_order: 123,
        expected_type: 'answer',
        expected_answer: '<string>',
        expected_tool_name: '<string>',
        expected_tool_args: {}
      }
    ]
  })
};

fetch('https://{tenant_id}.api.useago.com/api/v1/simulation/datasets/{dataset_id}/test-cases', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

201

{
  "id": "<string>",
  "question": "<string>",
  "expected_type": "<string>",
  "object": "simulation_test_case",
  "expected_answer": "<string>",
  "expected_tool_name": "<string>",
  "expected_tool_args": {},
  "expected_agent_id": "<string>",
  "expected_agent_name": "<string>",
  "metadata": {},
  "order": 123,
  "persona_id": "<string>",
  "persona_name": "<string>",
  "api_data_overrides": {},
  "tool_call_overrides": {},
  "steps": [],
  "created_at": "<string>"
}

Authorizations

X-API-Key · string · header · required

Path Parameters

dataset_id · string · required

Body

application/json

Schema for creating a simulation test case via the v1 API.

question · string · required

expected_type · string · default: answer

expected_answer · string | null

expected_tool_name · string | null

expected_tool_args · Expected Tool Args · object | null

expected_agent_id · string | null

metadata · Metadata · object | null

persona_id · string | null

api_data_overrides · Api Data Overrides · object | null

tool_call_overrides · Tool Call Overrides · object | null

steps · ConversationStepIn · object[] | null

Show child attributes

Response

201 - application/json

Created

Response schema for simulation test cases.

id · string · required

question · string · required

expected_type · string · required

object · string · default: simulation_test_case

expected_answer · string | null

expected_tool_name · string | null

expected_tool_args · Expected Tool Args · object | null

expected_agent_id · string | null

expected_agent_name · string | null

metadata · Metadata · object | null

order · integer | null

persona_id · string | null

persona_name · string | null

api_data_overrides · Api Data Overrides · object | null

tool_call_overrides · Tool Call Overrides · object | null

steps · ConversationStepOut · object[]

Show child attributes

created_at · string | null