public

Read Shared Dataset Run

Changed on

Get runs in projects run over a dataset that has been shared.

get/api/v1/public/{share_token}/datasets/runs/{run_id}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/public/{share_token}/datasets/runs/{run_id}
  • Auth
    none declared

Path parameters

run_idstring uuid required
share_tokenstring uuid required

Query parameters

exclude_s3_stored_attributesboolean

Response

Successful Response

namestring required
inputsobject nullable
inputs_previewstring nullable
run_type'tool' | 'chain' | 'llm' | 'retriever' | 'embedding' | 'prompt' | 'parser' required

Enum for run types.

start_timestring date-time
end_timestring date-time nullable
extraobject nullable
errorstring nullable
execution_orderinteger
serializedobject nullable
outputsobject nullable
outputs_previewstring nullable
parent_run_idstring uuid nullable
manifest_idstring uuid nullable
manifest_s3_idstring uuid nullable
eventsobject[] nullable
tagsstring[] nullable
inputs_s3_urlsobject nullable
outputs_s3_urlsobject nullable
s3_urlsobject nullable
trace_idstring uuid required
dotted_orderstring required
trace_min_start_timestring date-time nullable
trace_max_start_timestring date-time nullable
idstring uuid required
statusstring required
child_run_idsstring[] nullable
direct_child_run_idsstring[] nullable
parent_run_idsstring[] nullable
feedback_statsobject nullable
reference_example_idstring uuid nullable
total_tokensinteger
prompt_tokensinteger
completion_tokensinteger
prompt_token_detailsobject nullable
completion_token_detailsobject nullable
total_coststring nullable
prompt_coststring nullable
completion_coststring nullable
prompt_cost_detailsobject nullable
completion_cost_detailsobject nullable
price_model_idstring uuid nullable
first_token_timestring date-time nullable
messagesobject[] nullable
session_idstring uuid required

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

      the / response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

    • info

      the // response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

    • info

      the / response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

    • info

      the // response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

    • info

      the / response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status