The datasets API from LangChain — 28 operation(s) for datasets.
openapi: 3.1.0
info:
title: LangSmith access_policies datasets API
description: 'The LangSmith API is used to programmatically create and manage LangSmith resources.
## Host
https://api.smith.langchain.com
## Authentication
To authenticate with the LangSmith API, set the `X-Api-Key` header
to a valid [LangSmith API key](https://docs.langchain.com/langsmith/create-account-api-key#create-an-api-key).
'
version: 0.1.0
servers:
- url: /
tags:
- name: datasets
paths:
/api/v1/datasets:
get:
tags:
- datasets
summary: Read Datasets
description: Get all datasets by query params and owner.
operationId: read_datasets_api_v1_datasets_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: id
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Id
- name: data_type
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/DataType'
- $ref: '#/components/schemas/DataType'
- type: 'null'
title: Data Type
- name: name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name
- name: name_contains
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name Contains
- name: metadata
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Metadata
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 100
title: Limit
- name: sort_by
in: query
required: false
schema:
$ref: '#/components/schemas/SortByDatasetColumn'
default: last_session_start_time
- name: sort_by_desc
in: query
required: false
schema:
type: boolean
default: true
title: Sort By Desc
- name: tag_value_id
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Tag Value Id
- name: exclude_corrections_datasets
in: query
required: false
schema:
type: boolean
default: false
title: Exclude Corrections Datasets
- name: exclude
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/GetDatasetsSelect'
- type: 'null'
title: Exclude
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Dataset'
title: Response Read Datasets Api V1 Datasets Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- datasets
summary: Create Dataset
description: Create a new dataset.
operationId: create_dataset_api_v1_datasets_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Dataset'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- datasets
summary: Delete Datasets
description: Delete multiple datasets.
operationId: delete_datasets_api_v1_datasets_delete
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_ids
in: query
required: true
schema:
type: array
items:
type: string
format: uuid
maxItems: 100
title: Dataset Ids
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/stream:
get:
tags:
- datasets
summary: Read Datasets Stream
description: Stream all datasets by query params and owner as JSON patches.
operationId: read_datasets_stream_api_v1_datasets_stream_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: id
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Id
- name: data_type
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/DataType'
- $ref: '#/components/schemas/DataType'
- type: 'null'
title: Data Type
- name: name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name
- name: name_contains
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name Contains
- name: metadata
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Metadata
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 100
title: Limit
- name: sort_by
in: query
required: false
schema:
$ref: '#/components/schemas/SortByDatasetColumn'
default: last_session_start_time
- name: sort_by_desc
in: query
required: false
schema:
type: boolean
default: true
title: Sort By Desc
- name: tag_value_id
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Tag Value Id
- name: exclude_corrections_datasets
in: query
required: false
schema:
type: boolean
default: false
title: Exclude Corrections Datasets
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}:
get:
tags:
- datasets
summary: Read Dataset
description: Get a specific dataset.
operationId: read_dataset_api_v1_datasets__dataset_id__get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Dataset'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- datasets
summary: Delete Dataset
description: Delete a specific dataset.
operationId: delete_dataset_api_v1_datasets__dataset_id__delete
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- datasets
summary: Update Dataset
description: Update a specific dataset.
operationId: update_dataset_api_v1_datasets__dataset_id__patch
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetUpdate'
responses:
'200':
description: Dataset updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetSchemaForUpdate'
headers:
X-Updated-Examples-Count:
description: Number of examples updated
schema:
type: integer
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/upload:
post:
tags:
- datasets
summary: Upload Csv Dataset
description: Create a new dataset from a CSV or JSONL file.
operationId: upload_csv_dataset_api_v1_datasets_upload_post
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_upload_csv_dataset_api_v1_datasets_upload_post'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Dataset'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
/api/v1/datasets/upload-experiment:
post:
tags:
- datasets
summary: Upload Experiment
description: Upload an experiment that has already been run.
operationId: upload_experiment_api_v1_datasets_upload_experiment_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentResultsUpload'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentResultsUploadResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
/api/v1/datasets/{dataset_id}/versions:
get:
tags:
- datasets
summary: Get Dataset Versions
description: Get dataset versions.
operationId: get_dataset_versions_api_v1_datasets__dataset_id__versions_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
- name: search
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Search
- name: example
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Example
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 100
title: Limit
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DatasetVersion'
title: Response Get Dataset Versions Api V1 Datasets Dataset Id Versions Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/versions/diff:
get:
tags:
- datasets
summary: Diff Dataset Versions
description: Get diff between two dataset versions.
operationId: diff_dataset_versions_api_v1_datasets__dataset_id__versions_diff_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
- name: from_version
in: query
required: true
schema:
anyOf:
- type: string
format: date-time
- type: string
title: From Version
- name: to_version
in: query
required: true
schema:
anyOf:
- type: string
format: date-time
- type: string
title: To Version
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetDiffInfo'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/version:
get:
tags:
- datasets
summary: Get Dataset Version
description: Get dataset version by as_of or exact tag.
operationId: get_dataset_version_api_v1_datasets__dataset_id__version_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
- name: as_of
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: As Of
- name: tag
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Tag
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetVersion'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/tags:
put:
tags:
- datasets
summary: Update Dataset Version
description: Set a tag on a dataset version.
operationId: update_dataset_version_api_v1_datasets__dataset_id__tags_put
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutDatasetVersionsSchema'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetVersion'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/openai:
get:
tags:
- datasets
summary: Download Dataset Openai
description: Download a dataset as OpenAI Evals Jsonl format.
operationId: download_dataset_openai_api_v1_datasets__dataset_id__openai_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
- name: as_of
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used.
title: As Of
description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used.
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/openai_ft:
get:
tags:
- datasets
summary: Download Dataset Openai Ft
description: Download a dataset as OpenAI Jsonl format.
operationId: download_dataset_openai_ft_api_v1_datasets__dataset_id__openai_ft_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
- name: as_of
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used.
title: As Of
description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used.
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/csv:
get:
tags:
- datasets
summary: Download Dataset Csv
description: Download a dataset as CSV format.
operationId: download_dataset_csv_api_v1_datasets__dataset_id__csv_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
- name: as_of
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used.
title: As Of
description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used.
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/jsonl:
get:
tags:
- datasets
summary: Download Dataset Jsonl
description: Download a dataset as CSV format.
operationId: download_dataset_jsonl_api_v1_datasets__dataset_id__jsonl_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
- name: as_of
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used.
title: As Of
description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used.
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/runs:
post:
tags:
- datasets
summary: Read Examples With Runs
description: Fetch examples for a dataset, and fetch the runs for each example if they are associated with the given session_ids.
operationId: read_examples_with_runs_api_v1_datasets__dataset_id__runs_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
- name: format
in: query
required: false
schema:
anyOf:
- const: csv
type: string
- type: 'null'
description: Response format, e.g., 'csv'
title: Format
description: Response format, e.g., 'csv'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryExampleSchemaWithRunsRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/ExampleWithRunsCH'
title: ExamplesWithRuns
- type: 'null'
title: Response Read Examples With Runs Api V1 Datasets Dataset Id Runs Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/group/runs:
post:
tags:
- datasets
summary: Read Examples With Runs Grouped
description: Fetch examples for a dataset, and fetch the runs for each example if they are associated with the given session_ids.
operationId: read_examples_with_runs_grouped_api_v1_datasets__dataset_id__group_runs_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryGroupedExamplesWithRuns'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GroupedExamplesWithRunsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/runs/delta:
post:
tags:
- datasets
summary: Read Delta
description: Fetch the number of regressions/improvements for each example in a dataset, between sessions[0] and sessions[1].
operationId: read_delta_api_v1_datasets__dataset_id__runs_delta_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryFeedbackDelta'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SessionFeedbackDelta'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/runs/delta/stream:
post:
tags:
- datasets
summary: Read Delta Stream
description: "Stream feedback deltas for multiple feedback keys.\n\nReturns results in chunks as they become available. Each chunk contains\nresults for one or more feedback keys. Errors for individual chunks are\nincluded in the response rather than failing the entire operation.\n\nResponse format (SSE):\n event: data\n data: {\"feedback_deltas\": {\"key1\": {session_id: {...}}, ...}, \"errors\": null}\n\n event: data\n data: {\"feedback_deltas\": {\"key2\": {...}}, \"errors\": null}\n\n event: end"
operationId: read_delta_stream_api_v1_datasets__dataset_id__runs_delta_stream_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryFeedbackDeltaBatch'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/experiments/grouped:
post:
tags:
- datasets
summary: Read Grouped Experiments
description: Stream grouped and aggregated experiments.
operationId: read_grouped_experiments_api_v1_datasets__dataset_id__experiments_grouped_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GroupedExperimentsRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/datasets/{dataset_id}/share:
get:
tags:
- datasets
summary: Read Dataset Share State
description: Get the state of sharing a dataset
operationId: read_dataset_share_state_api_v1_datasets__dataset_id__share_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/DatasetShareSchema'
- type: 'null'
title: Response Read Dataset Share State Api V1 Datasets Dataset Id Share Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- datasets
summary: Share Dataset
description: Share a dataset.
operationId: share_dataset_api_v1_datasets__dataset_id__share_put
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
type: string
format: uuid
title: Dataset Id
- name: share_projects
in: query
required: false
schema:
type: boolean
default: false
title: Share Projects
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetShareSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- datasets
summary: Unshare Dataset
description: Unshare a dataset.
operationId: unshare_dataset_api_v1_datasets__dataset_id__share_delete
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: path
required: true
schema:
# --- truncated at 32 KB (112 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/langchain/refs/heads/main/openapi/langchain-datasets-api-openapi.yml