examples

Read Examples

Changed on

Get all examples by query params

get/api/v1/examples

Request

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

Query parameters

idstring[] nullable
string date-time
OR
string
metadatastring nullable
full_text_containsstring[] nullable
splitsstring[] nullable
datasetstring uuid nullable
offsetinteger
limitinteger
order'recent' | 'random' | 'recently_created' | 'id'
random_seednumber nullable
selectExampleSelect[]
exclude_default_fieldsboolean

Return only the fields in select, plus id. Other default fields (created_at, modified_at, inputs, name, dataset_id) are absent unless selected.

descendingboolean nullable
filterstring nullable

Response

Successful Response

outputsobject nullable
dataset_idstring uuid required
source_run_idstring uuid nullable
source_session_idstring uuid nullable
source_run_start_timestring date-time nullable
source_trace_idstring uuid nullable
metadataobject nullable
inputsobject required
created_atstring date-time
idstring uuid required
namestring required
modified_atstring date-time nullable
source_thread_idstring nullable
attachment_urlsobject nullable

Changes

  • e9b5f2bcae6fRevision changes
    • info

      added the new optional query request parameter exclude_default_fields

  • 1a8ee9358d81Revision changes
    • breaking

      for the query request parameter select, default value was changed from id created_at modified_at name dataset_id source_run_id metadata inputs outputs to id created_at modified_at name dataset_id source_run_id source_session_id source_run_start_time source_trace_id source_thread_id metadata inputs outputs

    • 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

    • info

      added the enum value source_run_start_time to the property items/ of the query request parameter select

    • info

      added the enum value source_session_id to the property items/ of the query request parameter select

    • info

      added the enum value source_thread_id to the property items/ of the query request parameter select

    • info

      added the enum value source_trace_id to the property items/ of the query request parameter select

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status