datasets

Get a specific dataset.

get/api/v1/datasets/{dataset_id}

Request

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

Path parameters

dataset_idstring uuid required

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

    • 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