Read Shared Dataset

Get dataset by ids or the shared dataset if not specifed.

GET /api/v1/public/{share_token}/datasets

Error

A valid request URL is required to generate request examples

200

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

Path Parameters

share_token · string<uuid> · required

Query Parameters

offset · integer · default: 0

Required range: x >= 0

limit · integer · default: 100

Required range: 1 <= x <= 100

sort_by · enum<string> · default: last_session_start_time

Enum for available dataset columns to sort by.

Available options: name, created_at, last_session_start_time, example_count, session_count, modified_at

sort_by_desc · boolean · default: true

Response

200

application/json

Successful Response

Public schema for datasets.

Doesn't currently include session counts/stats since public test project sharing is not yet shipped

name · string · required

id · string<uuid> · required

example_count · integer · required

description · string | null

created_at · string<date-time>

inputs_schema_definition · Inputs Schema Definition · object

outputs_schema_definition · Outputs Schema Definition · object

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