Read Example

Get a specific example.

GET /api/v1/examples/{example_id}

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",
  "source_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_run_start_time": "2023-11-07T05:31:56Z",
  "source_trace_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

Path Parameters

example_id · string<uuid> · required

Query Parameters

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.

dataset · string<uuid> | null

Response

200

application/json

Successful Response

Example schema.

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

source_session_id · string<uuid> | null

source_run_start_time · string<date-time> | null

source_trace_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