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>'
{
  "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
}
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