Validate Example

Validate an example.

POST /api/v1/examples/validate

Error

A valid request URL is required to generate request examples

200

{
  "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inputs": {},
  "outputs": {},
  "created_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "source_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "split": "base",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "use_source_run_io": false,
  "overwrite": false
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Response

200 - application/json

Successful Response

Validation result for Example, combining fields from Create/Base/Update schemas.

dataset_id · string<uuid> | null

inputs · Inputs · object | null

outputs · Outputs · object | null

created_at · string<date-time> | null

metadata · Metadata · object | null

source_run_id · string<uuid> | null

split · string[] string

id · string<uuid> | null

use_source_run_io · boolean · default: false

overwrite · boolean · default: false