run

Get all runs by query in body payload.

post/api/v1/runs/stats

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/runs/stats
  • 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[] required
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
groupsstring[] nullable
selectRunStatsSelect[] nullable
reference_dataset_idstring uuid nullable
include_detailsboolean

Response

Successful Response

OR
object required

Changes

    • breaking

      the request property became required

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      the request property's minItems was increased to 1

    • 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 new optional request property

    • info

      added the new optional request property

    • info

      added the new group_count enum value to the request property //

    • breaking

      response property anyOf[subschema #1: RunStats]/completion_cost list-of-types was widened by adding types number to media type application/json of response 200

    • breaking

      response property anyOf[subschema #1: RunStats]/cost_p50 list-of-types was widened by adding types number to media type application/json of response 200

    • breaking

      response property anyOf[subschema #1: RunStats]/cost_p99 list-of-types was widened by adding types number to media type application/json of response 200

    • breaking

      response property anyOf[subschema #1: RunStats]/prompt_cost list-of-types was widened by adding types number to media type application/json of response 200

    • breaking

      response property anyOf[subschema #1: RunStats]/total_cost list-of-types was widened by adding types number to media type application/json of response 200

    • breaking

      response property anyOf[subschema #2]/additionalProperties/completion_cost list-of-types was widened by adding types number to media type application/json of response 200

    • breaking

      response property anyOf[subschema #2]/additionalProperties/cost_p50 list-of-types was widened by adding types number to media type application/json of response 200

    • breaking

      response property anyOf[subschema #2]/additionalProperties/cost_p99 list-of-types was widened by adding types number to media type application/json of response 200

    • breaking

      response property anyOf[subschema #2]/additionalProperties/prompt_cost list-of-types was widened by adding types number to media type application/json of response 200

    • breaking

      response property anyOf[subschema #2]/additionalProperties/total_cost list-of-types was widened by adding types number to media type application/json of response 200

    • breaking

      the // response's property type changed from string to number for status

    • breaking

      the // response's property type changed from string to number for status

    • breaking

      the // response's property type changed from string to number for status

    • breaking

      the // response's property type changed from string to number for status

    • breaking

      the // response's property type changed from string to number for status

    • breaking

      the /// response's property type changed from string to number for status

    • breaking

      the /// response's property type changed from string to number for status

    • breaking

      the /// response's property type changed from string to number for status

    • breaking

      the /// response's property type changed from string to number for status

    • breaking

      the /// response's property type changed from string to number for status