run

Query Runs

Changed on
post/api/v1/runs/query

Request

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

Request body

idstring[] nullable
tracestring uuid nullable

Filter runs by trace ID. When set, limit and cursor-based pagination are not applied — all runs in the trace are returned in a single response.

parent_runstring uuid nullable
run_type'tool' | 'chain' | 'llm' | 'retriever' | 'embedding' | 'prompt' | 'parser'

Enum for run types.

sessionstring[] nullable
reference_examplestring[] nullable
execution_orderinteger nullable
start_timestring date-time nullable
end_timestring date-time nullable
errorboolean nullable
querystring nullable
filterstring nullable
trace_filterstring nullable
tree_filterstring nullable
is_rootboolean nullable
data_source_type'current' | 'historical' | 'lite' | 'root_lite' | 'runs_feedbacks_rmt_wide'

Enum for run data source types.

skip_paginationboolean nullable
search_filterstring nullable
use_experimental_searchboolean
cursorstring nullable
limitinteger

Maximum number of runs to return. Not applied when trace is set — all runs in the trace are returned in a single response.

selectRunSelect[]
order'asc' | 'desc'

Enum for run start date order.

skip_prev_cursorboolean

Response

Successful Response

cursorsobject required
search_cursorsobject nullable
parsed_querystring 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

      endpoint deprecated

    • 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