Create New Dataset

Create a new simulation dataset.

POST /api/v1/simulation/datasets

Create New Dataset

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/simulation/datasets \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "agent_id": "<string>"
}
'

import requests

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

payload = {
    "name": "<string>",
    "description": "<string>",
    "agent_id": "<string>"
}
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({name: '<string>', description: '<string>', agent_id: '<string>'})
};

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

201

{
  "id": "<string>",
  "name": "<string>",
  "object": "simulation_dataset",
  "description": "<string>",
  "agent_id": "<string>",
  "agent_name": "<string>",
  "default_persona_id": "<string>",
  "test_case_count": 0,
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

X-API-Key · string · header · required

Body

application/json

Schema for creating a simulation dataset via the v1 API.

Note: default_persona_id can only be set via update, not create.

name · string · required

description · string | null

agent_id · string | null

Response

201 - application/json

Created

Response schema for simulation datasets.

id · string · required

name · string · required

object · string · default: simulation_dataset

description · string | null

agent_id · string | null

agent_name · string | null

default_persona_id · string | null

test_case_count · integer · default: 0

created_at · string | null

updated_at · string | null