Get Agent Evaluation Run

GET

agents

{id}

test-runs

{runId}

Get Agent Evaluation Run

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

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

fetch('https://api.dialnexa.com/v1/agents/{id}/test-runs/{runId}', 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}/test-runs/{runId}",
  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}/test-runs/{runId}"

	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}/test-runs/{runId}")

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>",
    "status": "queued",
    "target": "draft",
    "mode": "text",
    "llm": "primary",
    "test_ids": [
      "<string>"
    ],
    "total": 123,
    "version_number": 123,
    "trigger": "manual",
    "repeat": 123,
    "passed": 123,
    "failed": 123,
    "errored": 123,
    "cost_inr": 123,
    "duration_ms": 123,
    "insights": {},
    "insights_status": "pending",
    "created_by_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "finished_at": "2023-11-07T05:31:56Z",
    "conversations": [
      {
        "id": "<string>",
        "test_id": "<string>",
        "attempt": 123,
        "status": "queued",
        "language": {},
        "llm": {},
        "outcome": "pass",
        "failure_reason": "<string>",
        "summary": "<string>",
        "turns": 123,
        "last_turn": {}
      }
    ]
  },
  "timestamp": "2023-11-07T05:31:56Z"
}

Read only Get an agent evaluation run to inspect its current progress, result counters, insights, and conversation IDs. Poll this operation after starting a run.

Use the run ID returned by Start Agent Evaluation Run or List Agent Evaluation Runs.

Minimal request

No request body is needed. Supply the agent ID and run ID.

Evaluation run statuses

Status	Meaning	What to do
`queued`	Test conversations are waiting to start.	Continue polling.
`running`	The run is in progress.	Review conversation progress and continue polling.
`completed`	The run has finished.	Check passed, failed, errored and individual outcomes. Completion alone is not a pass.
`cancelled`	Reserved. Runs currently end as `completed`; there is no cancel operation.	Treat it like `completed` if it appears.

A conversation may be queued, calling, judging, scoring, or completed. While calling, its summary can include turns and last_turn; these are live indicators rather than a replacement for the full transcript. Insights have their own status: null until the run completes, then pending, ready, or failed. A completed run can still be waiting for insights.

Verify the result

A 200 response contains the run in data and its conversations list. Use a conversation’s id to inspect its transcript and judgement.

Errors and recovery

404 means the agent or run is not available in this workspace. Check both IDs. 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.

runId

string

required

Run ID from Start or List Agent Evaluation Runs.

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

Get Agent Evaluation Run

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

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

fetch('https://api.dialnexa.com/v1/agents/{id}/test-runs/{runId}', 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}/test-runs/{runId}",
  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}/test-runs/{runId}"

	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}/test-runs/{runId}")

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>",
    "status": "queued",
    "target": "draft",
    "mode": "text",
    "llm": "primary",
    "test_ids": [
      "<string>"
    ],
    "total": 123,
    "version_number": 123,
    "trigger": "manual",
    "repeat": 123,
    "passed": 123,
    "failed": 123,
    "errored": 123,
    "cost_inr": 123,
    "duration_ms": 123,
    "insights": {},
    "insights_status": "pending",
    "created_by_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "finished_at": "2023-11-07T05:31:56Z",
    "conversations": [
      {
        "id": "<string>",
        "test_id": "<string>",
        "attempt": 123,
        "status": "queued",
        "language": {},
        "llm": {},
        "outcome": "pass",
        "failure_reason": "<string>",
        "summary": "<string>",
        "turns": 123,
        "last_turn": {}
      }
    ]
  },
  "timestamp": "2023-11-07T05:31:56Z"
}

Overview

Endpoints

Get Agent Evaluation Run