Run Full Evaluation

POST /reports/{report_id}/run

Run Full Evaluation

cURL

curl --request POST \
  --url https://api.promptlayer.com/reports/{report_id}/run \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "dataset_id": 123,
  "refresh_dataset": true
}
'

import requests

url = "https://api.promptlayer.com/reports/{report_id}/run"

payload = {
    "name": "<string>",
    "dataset_id": 123,
    "refresh_dataset": True
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', dataset_id: 123, refresh_dataset: true})
};

fetch('https://api.promptlayer.com/reports/{report_id}/run', 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.promptlayer.com/reports/{report_id}/run",
  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([
    'name' => '<string>',
    'dataset_id' => 123,
    'refresh_dataset' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.promptlayer.com/reports/{report_id}/run"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"dataset_id\": 123,\n  \"refresh_dataset\": true\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.promptlayer.com/reports/{report_id}/run")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"dataset_id\": 123,\n  \"refresh_dataset\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.promptlayer.com/reports/{report_id}/run")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"dataset_id\": 123,\n  \"refresh_dataset\": true\n}"

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

201

{
  "success": true,
  "report_id": 123
}

{
  "success": true,
  "message": "<string>"
}

{
  "success": true,
  "message": "<string>"
}

{
  "success": true,
  "message": "<string>"
}

{
  "success": true,
  "message": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Legacy Dataset, Evaluation, and Report endpoints are deprecated for new workflows. Use the Tables API for new dataset import, evaluation, scoring, recalculation, and reporting workflows.

This endpoint allows you to run an evaluation pipeline. You can optionally update the dataset.

Authorizations

X-API-KEY · string · header · required

Path Parameters

report_id · integer · required

ID of the evaluation pipeline report to run.

Body

application/json

name · string · required

The name of the final report to be created. Must be between 1 and 255 characters in length.

Required string length: 1 - 255

dataset_id · integer | null

The ID of the dataset to use for the report. If not provided, uses the evaluation pipeline's default dataset.

refresh_dataset · boolean | null

Whether to refresh the dataset before running the report. Only applicable for dynamic datasets.

Response

201

application/json

Report run initiated successfully

success · boolean · required

report_id · integer · required

The ID of the created final report.