Skip to content

Create example set

POST
/example-sets
object
teamId
required

ID of the team that will own this example set

string
name
required

Human-readable name for the example set (1-255 characters)

string
>= 1 characters <= 255 characters
description

Optional description of what this example set is for

string
inputsSchema
required

Schema defining what inputs examples should have

object
files

File inputs/outputs

Array<object>
default:
object
id
required

Unique identifier for this file slot

string
label
required

Human-readable label for the file (e.g., ‘Input Document’)

string
description

Optional description of what this file represents

string
accept

Accepted file types (MIME types or extensions, e.g., ‘.pdf,.docx’)

string
required

Whether this file is required

boolean
default: true
multiple

Whether multiple files can be selected for this slot

boolean
contextRetrievalMode

How file content is retrieved: ‘semantic’ uses vector similarity search, ‘full’ returns all chunks

string
default: full
Allowed values: semantic full
datasets

Dataset inputs/outputs

Array<object>
default:
object
id
required

Unique identifier for this dataset slot

string
label
required

Human-readable label for the dataset (e.g., ‘Training Data’)

string
description

Optional description of what this dataset represents

string
schema

JSON Schema describing the expected dataset structure

required

Whether this dataset is required

boolean
default: true
multiple

Whether multiple datasets can be selected for this slot

boolean
filter

Optional row-level filter applied to any dataset in this slot

Array<object>
object
field
required

Column name in the dataset table

string
op
required
string
Allowed values: eq neq gt gte lt lte in not_in like is_null is_not_null
value
Any of:
string
dataInputs

Structured data inputs/outputs

Array<object>
default:
object
id
required

Unique identifier for this data input slot

string
label
required

Human-readable label for the data input (e.g., ‘Parameters’)

string
description

Optional description of what this data input represents

string
schema
required

JSON Schema describing the expected data structure

required

Whether this data input is required

boolean
default: true
outputsSchema
required

Schema defining what outputs examples should have

object
files

File inputs/outputs

Array<object>
default:
object
id
required

Unique identifier for this file slot

string
label
required

Human-readable label for the file (e.g., ‘Input Document’)

string
description

Optional description of what this file represents

string
accept

Accepted file types (MIME types or extensions, e.g., ‘.pdf,.docx’)

string
required

Whether this file is required

boolean
default: true
multiple

Whether multiple files can be selected for this slot

boolean
contextRetrievalMode

How file content is retrieved: ‘semantic’ uses vector similarity search, ‘full’ returns all chunks

string
default: full
Allowed values: semantic full
datasets

Dataset inputs/outputs

Array<object>
default:
object
id
required

Unique identifier for this dataset slot

string
label
required

Human-readable label for the dataset (e.g., ‘Training Data’)

string
description

Optional description of what this dataset represents

string
schema

JSON Schema describing the expected dataset structure

required

Whether this dataset is required

boolean
default: true
multiple

Whether multiple datasets can be selected for this slot

boolean
filter

Optional row-level filter applied to any dataset in this slot

Array<object>
object
field
required

Column name in the dataset table

string
op
required
string
Allowed values: eq neq gt gte lt lte in not_in like is_null is_not_null
value
Any of:
string
dataInputs

Structured data inputs/outputs

Array<object>
default:
object
id
required

Unique identifier for this data input slot

string
label
required

Human-readable label for the data input (e.g., ‘Parameters’)

string
description

Optional description of what this data input represents

string
schema
required

JSON Schema describing the expected data structure

required

Whether this data input is required

boolean
default: true
configuration

Optional pre-filled configuration values

object
files

File configurations

Array<object>
default:
object
id
required

Unique identifier for this file slot

string
label
required

Human-readable label for the file (e.g., ‘Input Document’)

string
description

Optional description of what this file represents

string
accept

Accepted file types (MIME types or extensions, e.g., ‘.pdf,.docx’)

string
required

Whether this file is required

boolean
default: true
multiple

Whether multiple files can be selected for this slot

boolean
contextRetrievalMode

How file content is retrieved: ‘semantic’ uses vector similarity search, ‘full’ returns all chunks

string
default: full
Allowed values: semantic full
value
Any of:
object
type
required
string
Allowed values: file
fileId
required

Reference to files table

string
datasets

Dataset configurations

Array<object>
default:
object
id
required

Unique identifier for this dataset slot

string
label
required

Human-readable label for the dataset (e.g., ‘Training Data’)

string
description

Optional description of what this dataset represents

string
schema

JSON Schema describing the expected dataset structure

required

Whether this dataset is required

boolean
default: true
multiple

Whether multiple datasets can be selected for this slot

boolean
filter

Optional row-level filter applied to any dataset in this slot

Array<object>
object
field
required

Column name in the dataset table

string
op
required
string
Allowed values: eq neq gt gte lt lte in not_in like is_null is_not_null
value
Any of:
string
value
Any of:
object
type
required
string
Allowed values: table
tableId
required

Reference to dataset_tables table

string
dataInputs

Structured data configurations

Array<object>
default:
object
id
required

Unique identifier for this data input slot

string
label
required

Human-readable label for the data input (e.g., ‘Parameters’)

string
description

Optional description of what this data input represents

string
schema
required

JSON Schema describing the expected data structure

required

Whether this data input is required

boolean
default: true
value
object
type
required
string
Allowed values: dataInput
value

Structured data value matching the schema

nullable
handlerOptions

LLM handler configuration

object
model

LLM model in {provider}/{model} format (e.g., vertexai/gemini-3-flash-preview)

string
temperature

Generation temperature (0 = deterministic, 2 = creative)

number
<= 2
maxTokens

Maximum output tokens

integer
webSearch

Web search configuration for automatic context retrieval

object
enabled
required

Enable automatic web search query generation and execution

boolean
maxQueries

Maximum number of queries to generate (1-5, default: 3)

integer
default: 3 >= 1 <= 5
maxResultsPerQuery

Maximum results per query (1-20, default: 5)

integer
default: 5 >= 1 <= 20
searchDepth

Search depth: basic (1 credit) or advanced (2 credits, default: basic)

string
default: basic
Allowed values: basic advanced
includeAnswer

Include AI-generated answer summary from Tavily (default: false)

boolean
urlScraping

URL scraping configuration

object
enabled

Enable automatic URL detection and scraping (default: true)

boolean
default: true
contentType

Content type for scraped pages (default: ‘markdown’)

string
default: markdown
Allowed values: html markdown text
renderJs

Enable JavaScript rendering (default: true)

boolean
default: true
iterationBudget

Maximum planning/retrieval iterations. Each iteration plans what to retrieve, fetches context, and evaluates sufficiency before answering.

integer
default: 1 >= 1 <= 20

Example set created successfully

object
exampleSetId
required

Unique identifier for the example set (nanoid format)

string
teamId
required

ID of the team that owns this example set

string
name
required

Human-readable name for the example set

string
description
required

Optional description of what this example set is for

string
nullable
activeConfigurationId
required

ID of the currently active configuration version

string
inputsSchema
required

Schema defining what inputs examples should have

object
files

File inputs/outputs

Array<object>
default:
object
id
required

Unique identifier for this file slot

string
label
required

Human-readable label for the file (e.g., ‘Input Document’)

string
description

Optional description of what this file represents

string
accept

Accepted file types (MIME types or extensions, e.g., ‘.pdf,.docx’)

string
required

Whether this file is required

boolean
default: true
multiple

Whether multiple files can be selected for this slot

boolean
contextRetrievalMode

How file content is retrieved: ‘semantic’ uses vector similarity search, ‘full’ returns all chunks

string
default: full
Allowed values: semantic full
datasets

Dataset inputs/outputs

Array<object>
default:
object
id
required

Unique identifier for this dataset slot

string
label
required

Human-readable label for the dataset (e.g., ‘Training Data’)

string
description

Optional description of what this dataset represents

string
schema

JSON Schema describing the expected dataset structure

required

Whether this dataset is required

boolean
default: true
multiple

Whether multiple datasets can be selected for this slot

boolean
filter

Optional row-level filter applied to any dataset in this slot

Array<object>
object
field
required

Column name in the dataset table

string
op
required
string
Allowed values: eq neq gt gte lt lte in not_in like is_null is_not_null
value
Any of:
string
dataInputs

Structured data inputs/outputs

Array<object>
default:
object
id
required

Unique identifier for this data input slot

string
label
required

Human-readable label for the data input (e.g., ‘Parameters’)

string
description

Optional description of what this data input represents

string
schema
required

JSON Schema describing the expected data structure

required

Whether this data input is required

boolean
default: true
outputsSchema
required

Schema defining what outputs examples should have

object
files

File inputs/outputs

Array<object>
default:
object
id
required

Unique identifier for this file slot

string
label
required

Human-readable label for the file (e.g., ‘Input Document’)

string
description

Optional description of what this file represents

string
accept

Accepted file types (MIME types or extensions, e.g., ‘.pdf,.docx’)

string
required

Whether this file is required

boolean
default: true
multiple

Whether multiple files can be selected for this slot

boolean
contextRetrievalMode

How file content is retrieved: ‘semantic’ uses vector similarity search, ‘full’ returns all chunks

string
default: full
Allowed values: semantic full
datasets

Dataset inputs/outputs

Array<object>
default:
object
id
required

Unique identifier for this dataset slot

string
label
required

Human-readable label for the dataset (e.g., ‘Training Data’)

string
description

Optional description of what this dataset represents

string
schema

JSON Schema describing the expected dataset structure

required

Whether this dataset is required

boolean
default: true
multiple

Whether multiple datasets can be selected for this slot

boolean
filter

Optional row-level filter applied to any dataset in this slot

Array<object>
object
field
required

Column name in the dataset table

string
op
required
string
Allowed values: eq neq gt gte lt lte in not_in like is_null is_not_null
value
Any of:
string
dataInputs

Structured data inputs/outputs

Array<object>
default:
object
id
required

Unique identifier for this data input slot

string
label
required

Human-readable label for the data input (e.g., ‘Parameters’)

string
description

Optional description of what this data input represents

string
schema
required

JSON Schema describing the expected data structure

required

Whether this data input is required

boolean
default: true
configuration
required

Pre-filled configuration values

object
files

File configurations

Array<object>
default:
object
id
required

Unique identifier for this file slot

string
label
required

Human-readable label for the file (e.g., ‘Input Document’)

string
description

Optional description of what this file represents

string
accept

Accepted file types (MIME types or extensions, e.g., ‘.pdf,.docx’)

string
required

Whether this file is required

boolean
default: true
multiple

Whether multiple files can be selected for this slot

boolean
contextRetrievalMode

How file content is retrieved: ‘semantic’ uses vector similarity search, ‘full’ returns all chunks

string
default: full
Allowed values: semantic full
value
Any of:
object
type
required
string
Allowed values: file
fileId
required

Reference to files table

string
datasets

Dataset configurations

Array<object>
default:
object
id
required

Unique identifier for this dataset slot

string
label
required

Human-readable label for the dataset (e.g., ‘Training Data’)

string
description

Optional description of what this dataset represents

string
schema

JSON Schema describing the expected dataset structure

required

Whether this dataset is required

boolean
default: true
multiple

Whether multiple datasets can be selected for this slot

boolean
filter

Optional row-level filter applied to any dataset in this slot

Array<object>
object
field
required

Column name in the dataset table

string
op
required
string
Allowed values: eq neq gt gte lt lte in not_in like is_null is_not_null
value
Any of:
string
value
Any of:
object
type
required
string
Allowed values: table
tableId
required

Reference to dataset_tables table

string
dataInputs

Structured data configurations

Array<object>
default:
object
id
required

Unique identifier for this data input slot

string
label
required

Human-readable label for the data input (e.g., ‘Parameters’)

string
description

Optional description of what this data input represents

string
schema
required

JSON Schema describing the expected data structure

required

Whether this data input is required

boolean
default: true
value
object
type
required
string
Allowed values: dataInput
value

Structured data value matching the schema

nullable
handlerOptions

LLM handler configuration

object
model

LLM model in {provider}/{model} format (e.g., vertexai/gemini-3-flash-preview)

string
temperature

Generation temperature (0 = deterministic, 2 = creative)

number
<= 2
maxTokens

Maximum output tokens

integer
webSearch

Web search configuration for automatic context retrieval

object
enabled
required

Enable automatic web search query generation and execution

boolean
maxQueries

Maximum number of queries to generate (1-5, default: 3)

integer
default: 3 >= 1 <= 5
maxResultsPerQuery

Maximum results per query (1-20, default: 5)

integer
default: 5 >= 1 <= 20
searchDepth

Search depth: basic (1 credit) or advanced (2 credits, default: basic)

string
default: basic
Allowed values: basic advanced
includeAnswer

Include AI-generated answer summary from Tavily (default: false)

boolean
urlScraping

URL scraping configuration

object
enabled

Enable automatic URL detection and scraping (default: true)

boolean
default: true
contentType

Content type for scraped pages (default: ‘markdown’)

string
default: markdown
Allowed values: html markdown text
renderJs

Enable JavaScript rendering (default: true)

boolean
default: true
iterationBudget

Maximum planning/retrieval iterations. Each iteration plans what to retrieve, fetches context, and evaluates sufficiency before answering.

integer
default: 1 >= 1 <= 20
status
required

Example set status: ‘active’ or ‘archived’

string
Allowed values: active archived
createdAt
required

When the example set was created (ISO 8601)

string format: date-time
updatedAt
required

When the example set was last modified (ISO 8601)

string format: date-time
createdBy
required

ID of the user who created this example set

string
nullable

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean