Read Dataset

Get a specific dataset.

GET /api/v1/datasets/{dataset_id}

Error

A valid request URL is required to generate request examples

200

{
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_count": 123,
  "modified_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "inputs_schema_definition": {},
  "outputs_schema_definition": {},
  "externally_managed": false,
  "transformations": [
    {
      "path": [
        "<string>"
      ]
    }
  ],
  "data_type": "kv",
  "example_count": 123,
  "last_session_start_time": "2023-11-07T05:31:56Z",
  "metadata": {},
  "baseline_experiment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

dataset_id · string<uuid> · required

Response

200

application/json

Successful Response

Dataset schema.

name · string · required

id · string<uuid> · required

tenant_id · string<uuid> · required

session_count · integer · required

modified_at · string<date-time> · required

description · string | null

created_at · string<date-time>

inputs_schema_definition · Inputs Schema Definition · object | null

outputs_schema_definition · Outputs Schema Definition · object | null

externally_managed · boolean | null · default: false

transformations · DatasetTransformation · object[] | null

Show child attributes

data_type · enum<string> | null · default: kv

Enum for dataset data types.

Available options: kv, llm, chat

example_count · integer | null

last_session_start_time · string<date-time> | null

metadata · Metadata · object | null

baseline_experiment_id · string<uuid> | null