Skip to main content
POST
/
v3
/
evals
/
experiments
/
{experiment_id}
/
results
Upload experiment results
curl --request POST \
  --url https://api.example.com/v3/evals/experiments/{experiment_id}/results \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "results": [
    {
      "experiment_item": {
        "dataset_item_id": "<string>",
        "outputs": {},
        "duration_ms": 123,
        "timestamp": "2023-11-07T05:31:56Z",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "error_reason": "<string>",
        "error_message": "<string>"
      },
      "scores": [
        {
          "evaluator_name": "<string>",
          "name": "<string>",
          "value": 123,
          "label": "<string>",
          "reasoning": "<string>",
          "error_reason": "<string>",
          "error_message": "<string>"
        }
      ]
    }
  ]
}
'
import requests

url = "https://api.example.com/v3/evals/experiments/{experiment_id}/results"

payload = { "results": [
        {
            "experiment_item": {
                "dataset_item_id": "<string>",
                "outputs": {},
                "duration_ms": 123,
                "timestamp": "2023-11-07T05:31:56Z",
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "error_reason": "<string>",
                "error_message": "<string>"
            },
            "scores": [
                {
                    "evaluator_name": "<string>",
                    "name": "<string>",
                    "value": 123,
                    "label": "<string>",
                    "reasoning": "<string>",
                    "error_reason": "<string>",
                    "error_message": "<string>"
                }
            ]
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    results: [
      {
        experiment_item: {
          dataset_item_id: '<string>',
          outputs: {},
          duration_ms: 123,
          timestamp: '2023-11-07T05:31:56Z',
          id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
          error_reason: '<string>',
          error_message: '<string>'
        },
        scores: [
          {
            evaluator_name: '<string>',
            name: '<string>',
            value: 123,
            label: '<string>',
            reasoning: '<string>',
            error_reason: '<string>',
            error_message: '<string>'
          }
        ]
      }
    ]
  })
};

fetch('https://api.example.com/v3/evals/experiments/{experiment_id}/results', 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.example.com/v3/evals/experiments/{experiment_id}/results",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'results' => [
        [
                'experiment_item' => [
                                'dataset_item_id' => '<string>',
                                'outputs' => [
                                                                
                                ],
                                'duration_ms' => 123,
                                'timestamp' => '2023-11-07T05:31:56Z',
                                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                'error_reason' => '<string>',
                                'error_message' => '<string>'
                ],
                'scores' => [
                                [
                                                                'evaluator_name' => '<string>',
                                                                'name' => '<string>',
                                                                'value' => 123,
                                                                'label' => '<string>',
                                                                'reasoning' => '<string>',
                                                                'error_reason' => '<string>',
                                                                'error_message' => '<string>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://api.example.com/v3/evals/experiments/{experiment_id}/results"

	payload := strings.NewReader("{\n  \"results\": [\n    {\n      \"experiment_item\": {\n        \"dataset_item_id\": \"<string>\",\n        \"outputs\": {},\n        \"duration_ms\": 123,\n        \"timestamp\": \"2023-11-07T05:31:56Z\",\n        \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"error_reason\": \"<string>\",\n        \"error_message\": \"<string>\"\n      },\n      \"scores\": [\n        {\n          \"evaluator_name\": \"<string>\",\n          \"name\": \"<string>\",\n          \"value\": 123,\n          \"label\": \"<string>\",\n          \"reasoning\": \"<string>\",\n          \"error_reason\": \"<string>\",\n          \"error_message\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v3/evals/experiments/{experiment_id}/results")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"results\": [\n    {\n      \"experiment_item\": {\n        \"dataset_item_id\": \"<string>\",\n        \"outputs\": {},\n        \"duration_ms\": 123,\n        \"timestamp\": \"2023-11-07T05:31:56Z\",\n        \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"error_reason\": \"<string>\",\n        \"error_message\": \"<string>\"\n      },\n      \"scores\": [\n        {\n          \"evaluator_name\": \"<string>\",\n          \"name\": \"<string>\",\n          \"value\": 123,\n          \"label\": \"<string>\",\n          \"reasoning\": \"<string>\",\n          \"error_reason\": \"<string>\",\n          \"error_message\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/evals/experiments/{experiment_id}/results")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"results\": [\n    {\n      \"experiment_item\": {\n        \"dataset_item_id\": \"<string>\",\n        \"outputs\": {},\n        \"duration_ms\": 123,\n        \"timestamp\": \"2023-11-07T05:31:56Z\",\n        \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n        \"error_reason\": \"<string>\",\n        \"error_message\": \"<string>\"\n      },\n      \"scores\": [\n        {\n          \"evaluator_name\": \"<string>\",\n          \"name\": \"<string>\",\n          \"value\": 123,\n          \"label\": \"<string>\",\n          \"reasoning\": \"<string>\",\n          \"error_reason\": \"<string>\",\n          \"error_message\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "api_version": "3.0",
  "kind": "NORMAL"
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}
{
  "api_version": "3.0",
  "kind": "ERROR",
  "error": {
    "code": 400,
    "message": "Resource Not Found",
    "errors": [
      {
        "reason": "ResourceNotFoundException",
        "message": "Resource Not Found",
        "help": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
experiment_id
string<uuid>
required

Path parameter for unique identifier of an experiment

Body

application/json

Request body for uploading a batch of experiment results.

​
results
Experiment Result Payload · object[]
required

Array of experiment results.

Response

Experiment results uploaded successfully.

Response object for standard API responses.

​
api_version
enum<string>
default:3.0

API version.

Available options:
2.0,
3.0
​
kind
enum<string>
default:NORMAL

Type of response, indicating a normal response.

Available options:
NORMAL