Create example

Create a new example.

POST /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",
  "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",
  "source_thread_id": "<string>",
  "attachment_urls": {}
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Body

application/json

Create class for Example.

dataset_id · string<uuid> · required

outputs · Outputs · object | null · deprecated

Deprecated: use reference_outputs instead.

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

inputs · Inputs · object | null

split · string[] string

id · string<uuid> | null

use_source_run_io · boolean · default: false

use_source_run_attachments · string[]

use_legacy_message_format · boolean · default: false

Use Legacy Message Format for LLM runs

created_at · string

reference_outputs · Reference Outputs · object | 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

source_thread_id · string | null

attachment_urls · Attachment Urls · object | null