POST
/
dataset
curl --request POST \
--url "https://api.coval.dev/dataset" \
--header "x-api-key: <COVAL_API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "dataset_name": "Restaurant transcripts",
  "dataset_metadata": {
    "info": "Additional information about the dataset."
  },
  "description": "Transcript ordering pizza",
  "test_set_type": "Transcript"
}'

{
  "message": "Dataset created/identified successfully",
  "dataset_id": 123
}
curl --request POST \
--url "https://api.coval.dev/dataset" \
--header "x-api-key: <COVAL_API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "dataset_name": "Restaurant transcripts",
  "dataset_metadata": {
    "info": "Additional information about the dataset."
  },
  "description": "Transcript ordering pizza",
  "test_set_type": "Transcript"
}'

Body

application/json
Dataset details to create
​
dataset_name
integer
required

Name of the dataset

​
description
string
required

Description of the dataset

​
test_set_type
enum<string>
default:DEFAULT
required

Type of the test set. Defaults to 'DEFAULT'.

Available options:
DEFAULT,
SCENARIO,
TRANSCRIPT,
WORKFLOW
​
dataset_metadata
string
required

Metadata of the dataset in JSON format. Requires 'description' key to be displayed in the UI

Response

200
application/json
Dataset created/identified successfully
​
message
string
Example:

"Dataset created/identified successfully"

​
dataset_id
integer

ID of the created/identified dataset

Was this page helpful?