Skip to main content
Client Create Ground Truth
curl --request POST \
  --url https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "evaluation_instructions": "<string>",
  "runs": [
    {
      "user_defined_id": "<string>",
      "data": {}
    }
  ]
}
'
{
  "id": 123,
  "version": 123,
  "name": "<string>",
  "evaluation_instructions": "<string>",
  "runs": [
    {
      "user_defined_id": "<string>",
      "data": {}
    }
  ]
}
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

Body

application/json
name
string
required

The name of the Ground Truth.

Minimum string length: 1
evaluation_instructions
string
required

Instructions used to evaluate Runs against this Ground Truth.

runs
ClientGroundTruthRun · object[]
required

The list of Runs that make up this Ground Truth.

Response

Successful Response

id
integer
required

The unique ID of the Ground Truth.

version
integer
required

The current version number of the Ground Truth.

name
string
required

The name of the Ground Truth.

evaluation_instructions
string
required

Instructions used to evaluate Runs against this Ground Truth.

runs
ClientGroundTruthRun · object[]
required

The list of Runs that make up this Ground Truth.