Skip to content
POST/api/v1/datasets/{datasetId}/cases

Append cases to a dataset

Bulk-inserts up to 1000 cases under the dataset. Each case has a required input and optional expectedOutput, metadata, and named split. Caller must be an editor on the dataset's project org.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Parameters

datasetId in pathrequired
string

Request body required

Example

{
  "cases": [
    {
      "input": "string",
      "expectedOutput": "string",
      "metadata": {},
      "split": "<Optional named partition (train/test/eva>"
    }
  ]
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "cases"
      ],
      "properties": {
        "cases": {
          "type": "array",
          "minItems": 1,
          "maxItems": 1000,
          "items": {
            "type": "object",
            "required": [
              "input"
            ],
            "properties": {
              "input": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100000
              },
              "expectedOutput": {
                "type": "string",
                "maxLength": 100000
              },
              "metadata": {
                "type": "object",
                "additionalProperties": true
              },
              "split": {
                "type": "string",
                "minLength": 1,
                "maxLength": 64,
                "pattern": "^[\\w.-]+$",
                "description": "Optional named partition (train/test/eval)."
              }
            }
          }
        }
      }
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Cases appended ({ appended, cases }).
400(no description)
401(no description)
403Forbidden — editor role required.
404Dataset not found or not in caller's project.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/datasets/{datasetId}/cases \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "cases": [ { "input": "string", "expectedOutput": "string", "metadata": {}, "split": "<Optional named partition (train/test/eva>" } ] }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/datasets/{datasetId}/cases",
  body: {
    "cases": [
      {
        "input": "string",
        "expectedOutput": "string",
        "metadata": {},
        "split": "<Optional named partition (train/test/eva>"
      }
    ]
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/datasets/{datasetId}/cases",
    body={
    "cases": [
        {
            "input": "string",
            "expectedOutput": "string",
            "metadata": {},
            "split": "<Optional named partition (train/test/eva>"
        }
    ]
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"cases":[{"input":"string","expectedOutput":"string","metadata":{},"split":"<Optional named partition (train/test/eva>"}]}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/datasets/{datasetId}/cases", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403404429

Other Datasets endpoints