examples

Read Example

Changed on

Get a specific example.

get/api/v1/examples/{example_id}

Request

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

Path parameters

example_idstring uuid required

Query parameters

string date-time
OR
string
datasetstring uuid 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

  • 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

    • 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