Retrieve a test run result

GET

tests

test_framework

results

{id}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const TestRunResult = await client.ai.tests.testFramework.v1.results.retrieve('id');

console.log(TestRunResult.id);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
test_run_result = client.ai.tests.test_framework.v1.results.retrieve(
    "id",
)
print(test_run_result.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	result, err := client.AI.Tests.TestFramework.V1.Results.Get(
		context.TODO(),
		"id",
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", result.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var response = client.ai().tests().testFramework().v1().results().retrieve("id");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $test_run_result = $client->ai->tests->testFramework->v1->results->retrieve(
    'id',
  );

  var_dump($test_run_result);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "id": 10119,
  "name": "Refund escalation flow - run",
  "agent": 1259,
  "agent_name": "Support Bot Under Test",
  "agent_inbound": false,
  "status": "completed",
  "success_rate": 0.8,
  "run_as_text": false,
  "is_cronjob": false,
  "runs": null,
  "met_expected_outcome_count": 4,
  "total_expected_outcome_count": 5,
  "total_runs_count": 5,
  "completed_runs_count": 5,
  "success_runs_count": 4,
  "failed_runs_count": 1,
  "scenarios": [
    {
      "id": 9512,
      "name": "Refund escalation flow"
    }
  ],
  "run_type": "scheduled",
  "created_at": "2026-10-13T18:04:05.123456Z",
  "updated_at": "2026-10-13T18:34:05.123456Z"
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The AI Tests service rejected the request."
    }
  ]
}

{
  "errors": [
    {
      "code": "10003",
      "title": "Unauthorized",
      "detail": "The API key is missing or invalid."
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Not Found",
      "detail": "The requested resource or URL could not be found."
    }
  ]
}

{
  "errors": [
    {
      "code": "10018",
      "title": "Unprocessable Entity",
      "detail": "Validation failed for the request payload."
    }
  ]
}

{
  "errors": [
    {
      "code": "10029",
      "title": "Too Many Requests",
      "detail": "Too many requests; retry later."
    }
  ]
}

{
  "errors": [
    {
      "code": "10063",
      "title": "Service Unavailable",
      "detail": "The test framework service is temporarily unavailable."
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

integer

required

Numeric ID of the test run batch.

Response

Test run batch detail.

integer

required

name

string

required

agent

integer

required

status

string

required

Run batch status: running, completed, failed, pending, in_progress, evaluating, in_queue, timeout, cancelled, or scaling_up.

created_at

string<date-time>

required

updated_at

string<date-time>

required

agent_name

string

agent_inbound

boolean

success_rate

Share of runs judged successful.

run_as_text

boolean

Whether the batch ran as text chat rather than voice calls.

is_cronjob

boolean

Whether this batch was started by a scheduled job.

runs

object | null

Per-run detail keyed by run ID.

Show child attributes

met_expected_outcome_count

total_expected_outcome_count

total_runs_count

completed_runs_count

success_runs_count

failed_runs_count

scenarios

object[] | null

Show child attributes

run_type

string | null

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const TestRunResult = await client.ai.tests.testFramework.v1.results.retrieve('id');

console.log(TestRunResult.id);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
test_run_result = client.ai.tests.test_framework.v1.results.retrieve(
    "id",
)
print(test_run_result.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	result, err := client.AI.Tests.TestFramework.V1.Results.Get(
		context.TODO(),
		"id",
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", result.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var response = client.ai().tests().testFramework().v1().results().retrieve("id");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $test_run_result = $client->ai->tests->testFramework->v1->results->retrieve(
    'id',
  );

  var_dump($test_run_result);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "id": 10119,
  "name": "Refund escalation flow - run",
  "agent": 1259,
  "agent_name": "Support Bot Under Test",
  "agent_inbound": false,
  "status": "completed",
  "success_rate": 0.8,
  "run_as_text": false,
  "is_cronjob": false,
  "runs": null,
  "met_expected_outcome_count": 4,
  "total_expected_outcome_count": 5,
  "total_runs_count": 5,
  "completed_runs_count": 5,
  "success_runs_count": 4,
  "failed_runs_count": 1,
  "scenarios": [
    {
      "id": 9512,
      "name": "Refund escalation flow"
    }
  ],
  "run_type": "scheduled",
  "created_at": "2026-10-13T18:04:05.123456Z",
  "updated_at": "2026-10-13T18:34:05.123456Z"
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The AI Tests service rejected the request."
    }
  ]
}

{
  "errors": [
    {
      "code": "10003",
      "title": "Unauthorized",
      "detail": "The API key is missing or invalid."
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Not Found",
      "detail": "The requested resource or URL could not be found."
    }
  ]
}

{
  "errors": [
    {
      "code": "10018",
      "title": "Unprocessable Entity",
      "detail": "Validation failed for the request payload."
    }
  ]
}

{
  "errors": [
    {
      "code": "10029",
      "title": "Too Many Requests",
      "detail": "Too many requests; retry later."
    }
  ]
}

{
  "errors": [
    {
      "code": "10063",
      "title": "Service Unavailable",
      "detail": "The test framework service is temporarily unavailable."
    }
  ]
}

Guides

Missions

AI Insights

Assistants API

Missions API

AI Tests API

Conversations API

For AI Agents

Retrieve a test run result

Authorizations

Path Parameters

Response