Agent tests

Run a test scenario

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

Queue a run of the scenario against the agent’s saved version; it starts as soon as the workspace has a free test slot. Poll GET /api/v1/test-runs/{run_id} until its status is passed, failed or error. Refused (402) without credits.

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.

scenario_idstringrequired

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.

Response

202Successful Response

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/{scenario_id}/runs?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.vaakyo.com/api/v1/agents/{agent_id}/tests/{scenario_id}/runs"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "X-API-Key": "<api-key>",
}

response = requests.post(url, params=params, headers=headers)
print(response.status_code, response.json())

const response = await fetch("https://api.vaakyo.com/api/v1/agents/{agent_id}/tests/{scenario_id}/runs?timezone=Asia/Kolkata", {
  method: "POST",
  headers: {
    "X-API-Key": "<api-key>",
  },
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (agents.edit)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}

{
  "detail": "rate limit exceeded; slow down"
}