Skip to main content
POST
/
eval_configs
/
{id}
/
records
Create Eval Config Record
curl --request POST \
  --url https://api.vogent.ai/api/eval_configs/{id}/records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recordType": "DIAL",
  "dialId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "systemPrompt": "<string>",
  "maxTurns": 123,
  "agentInputs": "<string>"
}
'
{
  "id": "<string>",
  "recordType": "DIAL",
  "dialId": "<string>",
  "prompt": {
    "id": "<string>",
    "systemPrompt": "<string>",
    "maxTurns": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>",
    "agentInputs": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

In the form Bearer <api_key_here>. You can find your api key in your dashboard.

Path Parameters

​
id
string
required

ID of the eval config.

Body

application/json

Create either a dial-based record (provide dialId) or a prompt-based record (provide prompt fields).

​
recordType
enum<string>
required

The type of record to create: DIAL or PROMPT.

Available options:
DIAL,
PROMPT
​
dialId
string

The ID of an existing dial to link (required for DIAL type).

​
name
string

The name of the prompt (for PROMPT type).

​
description
string

The description of the prompt (for PROMPT type).

​
systemPrompt
string

The system prompt (required for PROMPT type).

​
maxTurns
integer

The maximum number of conversation turns (for PROMPT type, defaults to 20).

​
agentInputs
string

JSON object of key-value pairs injected as agent variables (for PROMPT type).

Response

Successful operation

​
id
string
required
​
recordType
enum<string>
required

The type of evaluation record.

Available options:
DIAL,
PROMPT
​
dialId
string | null
​
prompt
object