Get an eval scenario

curl --request GET \
  --url https://app.miyon.ai/api/v1/evals/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://app.miyon.ai/api/v1/evals/{id}', 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://app.miyon.ai/api/v1/evals/{id}",
  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://app.miyon.ai/api/v1/evals/{id}"

	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://app.miyon.ai/api/v1/evals/{id}")

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

{
  "id": 123,
  "name": "<string>",
  "slug": "<string>",
  "active": true,
  "cases": [
    {
      "id": 123,
      "name": "<string>",
      "position": 123,
      "mode": "scripted",
      "turns": [
        {
          "id": 123,
          "name": "<string>",
          "position": 123,
          "user_input": "<string>",
          "no_more_events": true,
          "original_assistant_response": "<string>",
          "assistant_intent": "<string>",
          "assistant_contains": [
            "<string>"
          ],
          "assistant_contains_any": [
            "<string>"
          ],
          "assistant_not_contains": [
            "<string>"
          ],
          "tool_calls": [
            {
              "name": "<string>",
              "arguments_contains": {}
            }
          ],
          "source": {
            "conversation_id": 123,
            "conversation_name": "<string>",
            "imported_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "context": "<string>",
      "source": {
        "conversation_id": 123,
        "conversation_name": "<string>",
        "imported_at": "2023-11-07T05:31:56Z"
      },
      "user_persona": "<string>",
      "opening_message": "<string>",
      "max_turns": 123,
      "goal_intent": "<string>",
      "goal_tool_calls": [
        {
          "name": "<string>"
        }
      ]
    }
  ],
  "recent_runs": [
    {
      "id": 123,
      "status": "pending",
      "sequence_number": 123,
      "total_cases": 123,
      "passed_cases": 123,
      "failed_cases": 123,
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "duration": 123,
      "results": "<unknown>",
      "error_message": "<string>"
    }
  ],
  "runs_pagination": {
    "current_page": 123,
    "total_pages": 123,
    "total_entries": 123
  },
  "agent_id": 123,
  "description": "<string>",
  "number_id": 123,
  "number_name": "<string>",
  "meta": {
    "caller_model": "<string>",
    "judge_model": "<string>",
    "mock_responses": {},
    "tool_variants": [
      {
        "name": "<string>",
        "prompt_override": "<string>",
        "system_override": "<string>",
        "model_override": "<string>",
        "temperature_override": "<string>",
        "tool_overrides": {}
      }
    ]
  },
  "latest_run": {
    "id": 123,
    "status": "pending",
    "total_cases": 123,
    "passed_cases": 123,
    "failed_cases": 123,
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "agent_name": "<string>"
}

GET

api

evals

{id}

Get an eval scenario

curl --request GET \
  --url https://app.miyon.ai/api/v1/evals/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://app.miyon.ai/api/v1/evals/{id}', 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://app.miyon.ai/api/v1/evals/{id}",
  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://app.miyon.ai/api/v1/evals/{id}"

	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://app.miyon.ai/api/v1/evals/{id}")

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

{
  "id": 123,
  "name": "<string>",
  "slug": "<string>",
  "active": true,
  "cases": [
    {
      "id": 123,
      "name": "<string>",
      "position": 123,
      "mode": "scripted",
      "turns": [
        {
          "id": 123,
          "name": "<string>",
          "position": 123,
          "user_input": "<string>",
          "no_more_events": true,
          "original_assistant_response": "<string>",
          "assistant_intent": "<string>",
          "assistant_contains": [
            "<string>"
          ],
          "assistant_contains_any": [
            "<string>"
          ],
          "assistant_not_contains": [
            "<string>"
          ],
          "tool_calls": [
            {
              "name": "<string>",
              "arguments_contains": {}
            }
          ],
          "source": {
            "conversation_id": 123,
            "conversation_name": "<string>",
            "imported_at": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "context": "<string>",
      "source": {
        "conversation_id": 123,
        "conversation_name": "<string>",
        "imported_at": "2023-11-07T05:31:56Z"
      },
      "user_persona": "<string>",
      "opening_message": "<string>",
      "max_turns": 123,
      "goal_intent": "<string>",
      "goal_tool_calls": [
        {
          "name": "<string>"
        }
      ]
    }
  ],
  "recent_runs": [
    {
      "id": 123,
      "status": "pending",
      "sequence_number": 123,
      "total_cases": 123,
      "passed_cases": 123,
      "failed_cases": 123,
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "duration": 123,
      "results": "<unknown>",
      "error_message": "<string>"
    }
  ],
  "runs_pagination": {
    "current_page": 123,
    "total_pages": 123,
    "total_entries": 123
  },
  "agent_id": 123,
  "description": "<string>",
  "number_id": 123,
  "number_name": "<string>",
  "meta": {
    "caller_model": "<string>",
    "judge_model": "<string>",
    "mock_responses": {},
    "tool_variants": [
      {
        "name": "<string>",
        "prompt_override": "<string>",
        "system_override": "<string>",
        "model_override": "<string>",
        "temperature_override": "<string>",
        "tool_overrides": {}
      }
    ]
  },
  "latest_run": {
    "id": 123,
    "status": "pending",
    "total_cases": 123,
    "passed_cases": 123,
    "failed_cases": 123,
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "agent_name": "<string>"
}

Autorisierungen

Authorization

string

header

erforderlich

Scoped API token. Required scopes are listed on each operation in x-required-scopes.

Pfadparameter

integer

erforderlich

ID of the eval scenario.

Abfrageparameter

runs_page

integer

Standard:1

Page of recent_runs to return. Values below 1 count as 1.

Erforderlicher Bereich: x >= 1

per_page

integer

Standard:20

Size of the recent_runs page. Clamped to 1..20.

Erforderlicher Bereich: 1 <= x <= 20

Antwort

The scenario with its cases and a page of recent runs.

Full scenario as returned by get, create, replace and duplicate.

integer

erforderlich

ID of the scenario.

name

string

erforderlich

Scenario name.

slug

string

erforderlich

URL-safe identifier generated from name.

active

boolean

erforderlich

Whether the scenario is active in the dashboard.

cases

object[]

erforderlich

Test cases in order.

Show child attributes

recent_runs

object[]

erforderlich

A page of recent runs, newest first.

Show child attributes

runs_pagination

object

erforderlich

Paging information for recent_runs.

Show child attributes

agent_id

integer

erforderlich

The voice agent the scenario tests.

description

string | null

Free-text description.

number_id

integer

veraltet

Deprecated alias of agent_id.

number_name

string | null

veraltet

Deprecated alias of agent_name.

Get started

Voice Agents

Voice Agent Settings

Tools

Outbound Calls

Conversations

Evals

Get an eval scenario

Autorisierungen

Pfadparameter

Abfrageparameter

Antwort