Skip to content
Overmind
Get started
API Reference
Datasets

Create dataset (auto-increments version per agent)

client.datasets.create(DatasetCreateParams { agent, datapoints, generator_model, 5 more } body, RequestOptionsoptions?): DatasetCreateResponse { id, agent, created_at, 8 more }
POST/api/datasets/

CRUD for versioned datasets.

Datapoints are never exposed directly — they can only be read via GET /api/datasets/{id}/datapoints/ or created as part of POST /api/datasets/. To mutate data, POST a new dataset version.

ParametersExpand Collapse
body: DatasetCreateParams { agent, datapoints, generator_model, 5 more }
agent: string
formatuuid
datapoints: Array<Datapoint>
expected_output?: unknown
input?: unknown
order?: number
maximum9223372036854776000
minimum0
formatint64
persona?: string
maxLength128
tags?: unknown
generator_model?: string
maxLength128
make_active?: boolean
metadata?: unknown
name?: string
maxLength255
policy_hash?: string
maxLength64
source?: "seed" | "synthetic" | "augmented" | "production"
  • seed - Seed
  • synthetic - Synthetic
  • augmented - Augmented
  • production - Production
Accepts one of the following:
"seed"
"synthetic"
"augmented"
"production"
ReturnsExpand Collapse
DatasetCreateResponse { id, agent, created_at, 8 more }
id: string
formatuuid
agent: string
formatuuid
created_at: string
formatdate-time
datapoints: Array<Datapoint>
id: string
formatuuid
expected_output?: unknown
input?: unknown
order?: number
maximum9223372036854776000
minimum0
formatint64
persona?: string
maxLength128
tags?: unknown
num_datapoints: number
version: number
generator_model?: string
maxLength128
metadata?: unknown
name?: string
maxLength255
policy_hash?: string
maxLength64
source?: "seed" | "synthetic" | "augmented" | "production"
  • seed - Seed
  • synthetic - Synthetic
  • augmented - Augmented
  • production - Production
Accepts one of the following:
"seed"
"synthetic"
"augmented"
"production"
Create dataset (auto-increments version per agent)
import OvermindLab from 'overmind-lab';

const client = new OvermindLab();

const dataset = await client.datasets.create({
  agent: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  datapoints: [{}],
});

console.log(dataset.id);
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "agent": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "datapoints": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "expected_output": {},
      "input": {},
      "order": 0,
      "persona": "persona",
      "tags": {}
    }
  ],
  "num_datapoints": 0,
  "version": 0,
  "generator_model": "generator_model",
  "metadata": {},
  "name": "name",
  "policy_hash": "policy_hash",
  "source": "seed"
}
Returns Examples
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "agent": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "datapoints": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "expected_output": {},
      "input": {},
      "order": 0,
      "persona": "persona",
      "tags": {}
    }
  ],
  "num_datapoints": 0,
  "version": 0,
  "generator_model": "generator_model",
  "metadata": {},
  "name": "name",
  "policy_hash": "policy_hash",
  "source": "seed"
}