Read Examples

Get all examples by query params

GET /api/v1/examples

Error

A valid request URL is required to generate request examples

200

[
  {
    "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "inputs": {},
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "outputs": {},
    "source_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "attachment_urls": {}
  }
]

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

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Query Parameters

id · string<uuid>[] | null

as_of · string<date-time> string · default: latest

Only modifications made on or before this time are included. If None, the latest version of the dataset is used.

metadata · string | null

full_text_contains · string[] | null

splits · string[] | null

dataset · string<uuid> | null

offset · integer · default: 0

Required range: x >= 0

limit · integer · default: 100

Required range: 1 <= x <= 100

order · enum<string> · default: recent

Available options: recent, random, recently_created, id

random_seed · number | null

select · enum<string>[]

Available options: id, created_at, modified_at, name, dataset_id, source_run_id, metadata, inputs, outputs, attachment_urls

descending · boolean | null

filter · string | null

Response

200

application/json

Successful Response

dataset_id · string<uuid> · required

inputs · Inputs · object · required

id · string<uuid> · required

name · string · required

outputs · Outputs · object | null

source_run_id · string<uuid> | null

metadata · Metadata · object | null

created_at · string<date-time>

modified_at · string<date-time> | null

attachment_urls · Attachment Urls · object | null