datasets

Read Datasets

Changed on

Get all datasets by query params and owner.

get/api/v1/datasets

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/datasets
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Query parameters

idstring[] nullable
DataType[]
OR
'kv' | 'llm' | 'chat'

Enum for dataset data types.

namestring nullable
name_containsstring nullable
metadatastring nullable
offsetinteger
limitinteger
sort_by'name' | 'created_at' | 'last_session_start_time' | 'example_count' | 'session_count' | 'modified_at'

Enum for available dataset columns to sort by.

sort_by_descboolean
tag_value_idstring[] nullable
exclude_corrections_datasetsboolean
excludeGetDatasetsSelect[] nullable

Response

Successful Response

namestring required
descriptionstring nullable
created_atstring date-time
inputs_schema_definitionobject nullable
outputs_schema_definitionobject nullable
externally_managedboolean nullable
data_type'kv' | 'llm' | 'chat'

Enum for dataset data types.

idstring uuid required
tenant_idstring uuid required
example_countinteger nullable
session_countinteger required
modified_atstring date-time required
last_session_start_timestring date-time nullable
metadataobject nullable
baseline_experiment_idstring uuid nullable

Changes

  • 1a8ee9358d81Revision changes
    • breaking

      the / response's property type changed from object to string for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status