Agent tests

Create a test scenario

POSThttps://api.vaakyo.com/api/v1/agents/{agent_id}/tests

A scenario: the simulated caller (persona), values for the agent’s variables, the most caller turns, the criteria the judge checks and optional stub results for the agent’s HTTP tools.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the agents.edit permission.

X-API-KeyAuthorization: Beareragents.edit

Path parameters

agent_idstringrequired

The agent's id.

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

namestringrequired

1 to 120 characters

personastringrequired

10 to 4000 characters

variablesobject

max_turnsintegerdefault: 12

1 to 30

criteriaobject[]

at most 20 items

Show item attributes

textstringrequired

3 to 300 characters

requiredbooleandefault: true

tool_stubsobject

Response

201Success.

No body.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request POST \ --url 'https://api.vaakyo.com/api/v1/agents/{agent_id}/tests?timezone=Asia/Kolkata' \ --header 'X-API-Key: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "name": "Example", "persona": "personaxxx", "variables": {}, "max_turns": 12, "criteria": [ { "text": "text", "required": true } ], "tool_stubs": {} }'

import requests url = "https://api.vaakyo.com/api/v1/agents/{agent_id}/tests" params = { "timezone": "Asia/Kolkata", } headers = { "X-API-Key": "<api-key>", } payload = { "name": "Example", "persona": "personaxxx", "variables": {}, "max_turns": 12, "criteria": [ { "text": "text", "required": True, }, ], "tool_stubs": {}, } response = requests.post(url, params=params, headers=headers, json=payload) print(response.status_code, response.json())

const response = await fetch("https://api.vaakyo.com/api/v1/agents/{agent_id}/tests?timezone=Asia/Kolkata", { method: "POST", headers: { "X-API-Key": "<api-key>", "Content-Type": "application/json", }, body: JSON.stringify({ "name": "Example", "persona": "personaxxx", "variables": {}, "max_turns": 12, "criteria": [ { "text": "text", "required": true } ], "tool_stubs": {} }), }) const data = await response.json() console.log(response.status, data)