v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
Datasets

Add new examples to a dataset

Appends new examples to an existing dataset.

If the dataset version is not passed, the latest version is selected. The inserted examples will be assigned autogenerated, unique IDs.

Payload Requirements

  • Each item in examples[] may contain any user-defined fields.
  • Do not include system-managed fields on input: id, created_at, updated_at. Requests that contain these fields in any example will be rejected.
  • Each example must contain at least one property (i.e., {} is invalid).

Valid example (create)

{
  "examples": [
    { "question": "What is 2+2?",
      "answer": "4",
      "topic": "math"
    }
  ]
}

Invalid example ('id' not allowed on create)

{
  "examples": [
    {
      "id": "ex_1",
      "input": "Hello"
    }
  ]
}

<Note>This endpoint is in beta, read more here.</Note>

post/v2/datasets/{dataset_id}/examples

Path parameters

dataset_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique dataset identifier (base64)

Query parameters

dataset_version_idstring

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique identifier of the dataset version

Request body

examplesCreateDatasetExampleInput[] required

Array of examples to append to the dataset version

Response

Examples successfully added to the dataset.

idstring required

Unique identifier for the dataset

namestring required

Name of the dataset

space_idstring required

Unique identifier for the space this dataset belongs to

created_atstring date-time required

Timestamp for when the dataset was created

updated_atstring date-time required

Timestamp for the last update of the dataset

dataset_version_idstring required

Unique identifier for the dataset version the examples were written to

example_idsstring[] required

IDs of the examples that were inserted or updated