Upload Examples

This endpoint allows clients to upload examples to a specified dataset by sending a multipart/form-data POST request. Each form part contains either JSON-encoded data or binary attachment files associated with an example.

POST /v1/platform/datasets/{dataset_id}/examples

Error

A valid request URL is required to generate request examples

201

{
  "as_of": "2024-01-21T10:00:00.123456Z",
  "count": 1,
  "example_ids": [
    "[\"123e4567-e89b-12d3-a456-426614174000\"]"
  ]
}

{
  "details": "{\"field\":\"dataset_id\",\"reason\":\"required\"}",
  "error": "Invalid request: missing required fields"
}

{
  "details": "{\"field\":\"dataset_id\",\"reason\":\"required\"}",
  "error": "Invalid request: missing required fields"
}

{
  "details": "{\"field\":\"dataset_id\",\"reason\":\"required\"}",
  "error": "Invalid request: missing required fields"
}

{
  "details": "{\"field\":\"dataset_id\",\"reason\":\"required\"}",
  "error": "Invalid request: missing required fields"
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

dataset_id · string<uuid> · required

Dataset ID

Body

multipart/form-data

{example_id} · file · required

The Example info as JSON. Can have fields 'metadata', 'split', 'use_source_run_io', 'source_run_id', 'created_at', 'modified_at'

{example_id}.inputs · file · required

The Example inputs as JSON

{example_id}.outputs · file

THe Example outputs as JSON

{example_id}.attachments.{name} · file

File attachment named {name}

Response

201

application/json

Created

as_of · string

Example:

"2024-01-21T10:00:00.123456Z"

count · integer

Example:

1

example_ids · string[]

Example:

[
  "[\"123e4567-e89b-12d3-a456-426614174000\"]"
]