Skip to main content
Client List Ground Truths
curl --request GET \
  --url https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths', 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://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths",
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://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths"

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))

}
HttpResponse<String> response = Unirest.get("https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths")

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
{
  "ground_truths": [
    {
      "id": 123,
      "version": 123,
      "name": "<string>",
      "evaluation_instructions": "<string>",
      "runs": [
        {
          "user_defined_id": "<string>",
          "data": {}
        }
      ]
    }
  ],
  "total_pages": 123,
  "page_number": 0,
  "page_size": 50
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}
Rate Limit: This endpoint is limited to requests per minute per user.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>. The <token> represents your API key, which must be acquired from the Kolena platform.

Path Parameters

agent_id
integer
required

Query Parameters

page_number
integer
default:0

Optionally specify the index of the Ground Truths page to fetch.

Required range: x >= 0
page_size
integer
default:50

Optionally specify the maximum number of Ground Truths to fetch.

Required range: 1 <= x <= 1000

Response

Successful Response

ground_truths
ClientGroundTruth · object[]
required

The list of Ground Truths.

total_pages
integer
required

The total number of pages of Ground Truths. Use the request arguments page_number and page_size to control which Ground Truths are fetched.

page_number
integer
default:0

The number of the fetched page.

Required range: x >= 0
page_size
integer
default:50

The page size, i.e. number of Ground Truths, fetched.

Required range: x <= 1000