List Agent Evaluation Tests

GET

agents

{id}

tests

curl --request GET \
  --url https://api.dialnexa.com/v1/agents/{id}/tests \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/agents/{id}/tests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/agents/{id}/tests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/agents/{id}/tests"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/agents/{id}/tests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "error": false,
  "statusCode": 200,
  "message": "Success",
  "data": [
    {
      "id": "<string>",
      "agent_id": "<string>",
      "name": "<string>",
      "type": "next_reply",
      "config": {},
      "enabled": true,
      "folder": "<string>",
      "template_id": "<string>",
      "last_result": {
        "run_id": "<string>",
        "passed": 123,
        "total": 123,
        "finished_at": "2023-11-07T05:31:56Z",
        "version_number": 123,
        "target": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "timestamp": "2023-11-07T05:31:56Z"
}

Read only List agent evaluation tests to retrieve the saved definitions, enabled state, and latest completed-run results for an agent. This request does not start test work.

The agent must belong to your workspace. Get its ID from List Agents.

Minimal request

No request body is needed. Supply the agent ID in the path.

Verify the result

A 200 response contains the saved tests in data, ordered by folder and then creation time. Use each test’s id in a run request. last_result is null until a completed run has results for that test.

Errors and recovery

An unknown agent, a deleted agent, or an agent in another workspace returns 404. Correct the agent ID before retrying. Read requests are safe to repeat. Missing, expired, or invalid API credentials return 401. See API authentication.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Agent ID from List Agents.

Response

Successful response.

success

enum<boolean>

required

Available options:

true

error

enum<boolean>

required

Available options:

false

statusCode

integer

required

Example:

200

message

string

required

Example:

"Success"

data

object[]

required

Show child attributes

timestamp

string<date-time>

required

List Agent Evaluation Tests

curl --request GET \
  --url https://api.dialnexa.com/v1/agents/{id}/tests \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/agents/{id}/tests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/agents/{id}/tests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/agents/{id}/tests"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/agents/{id}/tests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "error": false,
  "statusCode": 200,
  "message": "Success",
  "data": [
    {
      "id": "<string>",
      "agent_id": "<string>",
      "name": "<string>",
      "type": "next_reply",
      "config": {},
      "enabled": true,
      "folder": "<string>",
      "template_id": "<string>",
      "last_result": {
        "run_id": "<string>",
        "passed": 123,
        "total": 123,
        "finished_at": "2023-11-07T05:31:56Z",
        "version_number": 123,
        "target": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "timestamp": "2023-11-07T05:31:56Z"
}

Overview

Endpoints

List Agent Evaluation Tests