The run API from LangChain — 19 operation(s) for run.
openapi: 3.1.0
info:
title: LangSmith access_policies run API
description: 'The LangSmith API is used to programmatically create and manage LangSmith resources.
## Host
https://api.smith.langchain.com
## Authentication
To authenticate with the LangSmith API, set the `X-Api-Key` header
to a valid [LangSmith API key](https://docs.langchain.com/langsmith/create-account-api-key#create-an-api-key).
'
version: 0.1.0
servers:
- url: /
tags:
- name: run
paths:
/api/v1/runs/rules:
get:
tags:
- run
summary: List Rules
description: List all run rules.
operationId: list_rules_api_v1_runs_rules_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: dataset_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Dataset Id
- name: session_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Session Id
- name: type
in: query
required: false
schema:
anyOf:
- enum:
- session
- dataset
type: string
- type: 'null'
title: Type
- name: name_contains
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name Contains
- name: id
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Id
- name: evaluator_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Evaluator Id
- name: tag_value_id
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Tag Value Id
- name: include_backfill_progress
in: query
required: false
schema:
type: boolean
default: false
title: Include Backfill Progress
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RunRulesSchema'
title: Response List Rules Api V1 Runs Rules Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- run
summary: Create Rule
description: Create a new run rule.
operationId: create_rule_api_v1_runs_rules_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RunRulesCreateSchema'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunRulesSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runs/rules/validate:
post:
tags:
- run
summary: Validate Rule
description: 'Validate a rule by executing it with test data without creating a saved rule.
This endpoint allows testing LLM-as-judge evaluators before saving them. It accepts
a rule configuration (same as rule creation) and test data, executes the evaluator,
and returns the evaluation results in the same format as batch_invoke_evaluator.
Only LLM-as-judge rules (evaluators) are supported. Code evaluators are not allowed.
The evaluator execution traces are written to the database (in the "evaluators"
project), which allows users to see the evaluator execution history.'
operationId: validate_rule_api_v1_runs_rules_validate_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RunRulesValidateSchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
additionalProperties: true
type: object
type: array
title: Response Validate Rule Api V1 Runs Rules Validate Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
/api/v1/runs/rules/{rule_id}:
patch:
tags:
- run
summary: Update Rule
description: Update a run rule.
operationId: update_rule_api_v1_runs_rules__rule_id__patch
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: rule_id
in: path
required: true
schema:
type: string
format: uuid
title: Rule Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RunRulesUpdateSchema'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunRulesSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- run
summary: Delete Rule
description: Delete a run rule.
operationId: delete_rule_api_v1_runs_rules__rule_id__delete
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: rule_id
in: path
required: true
schema:
type: string
format: uuid
title: Rule Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runs/threads/{thread_id}:
get:
tags:
- run
summary: Thread Preview
description: Get preview of a thread.
operationId: thread_preview_api_v1_runs_threads__thread_id__get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: thread_id
in: path
required: true
schema:
type: string
title: Thread Id
- name: session_id
in: query
required: true
schema:
type: string
format: uuid
title: Session Id
- name: select
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/ThreadMessagesFormatType'
- type: 'null'
title: Select
- name: variables
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Variables
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ThreadPreviewResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runs/rules/{rule_id}/logs:
get:
tags:
- run
summary: List Rule Logs
description: List logs for a particular rule
operationId: list_rule_logs_api_v1_runs_rules__rule_id__logs_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: rule_id
in: path
required: true
schema:
type: string
format: uuid
title: Rule Id
- name: limit
in: query
required: false
schema:
type: integer
maximum: 1440
minimum: 1
default: 150
title: Limit
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: start_time
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Time
- name: end_time
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Time
- name: session_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Session Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RuleLogSchema'
title: Response List Rule Logs Api V1 Runs Rules Rule Id Logs Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runs/rules/{rule_id}/logs/v2:
get:
tags:
- run
summary: List Rule Logs V2
description: 'List logs for a particular rule with cursor-based pagination.
This endpoint handles S3-stored outcomes correctly by using run_outcomes_count
to predict batch sizes and avoid over-fetching.'
operationId: list_rule_logs_v2_api_v1_runs_rules__rule_id__logs_v2_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: rule_id
in: path
required: true
schema:
type: string
format: uuid
title: Rule Id
- name: limit
in: query
required: false
schema:
type: integer
maximum: 1440
minimum: 1
default: 150
title: Limit
- name: cursor
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Cursor
- name: backfill
in: query
required: false
schema:
type: boolean
default: false
title: Backfill
- name: start_time
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Time
- name: end_time
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Time
- name: session_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Session Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RuleLogsPaginatedResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runs/rules/{rule_id}/last_applied:
get:
tags:
- run
summary: Get Last Applied Rule
description: Get the last applied rule.
operationId: get_last_applied_rule_api_v1_runs_rules__rule_id__last_applied_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: rule_id
in: path
required: true
schema:
type: string
format: uuid
title: Rule Id
- name: backfill
in: query
required: false
schema:
type: boolean
default: false
title: Backfill
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RuleLogSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runs/rules/{rule_id}/trigger:
post:
tags:
- run
summary: Trigger Rule
description: Trigger a run rule manually.
operationId: trigger_rule_api_v1_runs_rules__rule_id__trigger_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: rule_id
in: path
required: true
schema:
type: string
format: uuid
title: Rule Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunRulesSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runs/rules/trigger:
post:
tags:
- run
summary: Trigger Rules
description: Trigger an array of run rules manually.
operationId: trigger_rules_api_v1_runs_rules_trigger_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TriggerRulesRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
/api/v1/runs/{run_id}:
get:
tags:
- run
summary: Read Run
description: Get a specific run.
operationId: read_run_api_v1_runs__run_id__get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: run_id
in: path
required: true
schema:
type: string
format: uuid
title: Run Id
- name: session_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Session Id
- name: start_time
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Time
- name: exclude_s3_stored_attributes
in: query
required: false
schema:
type: boolean
default: false
title: Exclude S3 Stored Attributes
- name: exclude_serialized
in: query
required: false
schema:
type: boolean
default: false
title: Exclude Serialized
- name: include_messages
in: query
required: false
schema:
type: boolean
default: false
title: Include Messages
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- run
summary: Update Run
description: Update a run.
operationId: update_run_api_v1_runs__run_id__patch
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: run_id
in: path
required: true
schema:
type: string
format: uuid
title: Run Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runs/{run_id}/share:
get:
tags:
- run
summary: Read Run Share State
description: Get the state of sharing of a run.
operationId: read_run_share_state_api_v1_runs__run_id__share_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: run_id
in: path
required: true
schema:
type: string
format: uuid
title: Run Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/RunShareSchema'
- type: 'null'
title: Response Read Run Share State Api V1 Runs Run Id Share Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- run
summary: Share Run
description: Share a run.
operationId: share_run_api_v1_runs__run_id__share_put
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: run_id
in: path
required: true
schema:
type: string
format: uuid
title: Run Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunShareSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- run
summary: Unshare Run
description: Unshare a run.
operationId: unshare_run_api_v1_runs__run_id__share_delete
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: run_id
in: path
required: true
schema:
type: string
format: uuid
title: Run Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runs/query/validate:
post:
tags:
- run
summary: Validate Runs Query
description: Validate runs query syntax, returns errors for broken queries.
operationId: validate_runs_query_api_v1_runs_query_validate_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BodyParamsForRunsQuerySchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunsQueryValidationResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runs/query:
post:
tags:
- run
summary: Query Runs
operationId: query_runs_api_v1_runs_query_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BodyParamsForRunsQuerySchema'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListRunsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
/api/v1/runs/generate-query:
post:
tags:
- run
summary: Generate Query For Runs
description: Get runs filter expression query for a given natural language query.
operationId: generate_query_for_runs_api_v1_runs_generate_query_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestBodyForRunsGenerateQuery'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseBodyForRunsGenerateQuery'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
/api/v1/runs/stats:
post:
tags:
- run
summary: Stats Runs
description: Get all runs by query in body payload.
operationId: stats_runs_api_v1_runs_stats_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RunStatsQueryParams'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/RunStats'
- additionalProperties:
$ref: '#/components/schemas/RunStats'
type: object
title: Response Stats Runs Api V1 Runs Stats Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
/api/v1/runs/group:
post:
tags:
- run
summary: Group Runs
description: Get runs grouped by an expression
operationId: group_runs_api_v1_runs_group_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: accept
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Accept
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RunGroupRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/runs/group/stats:
post:
tags:
- run
summary: Stats Group Runs
description: Get stats for the grouped runs.
operationId: stats_group_runs_api_v1_runs_group_stats_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RunGroupRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunGroupStats'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
/api/v1/runs/delete/traces:
post:
tags:
- run
summary: Delete Runs Abac
description: Delete specific runs by trace IDs.
operationId: delete_runs_abac_api_v1_runs_delete_traces_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Body_delete_runs_abac_api_v1_runs_delete_traces_post'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
/api/v1/runs/delete:
post:
tags:
- run
summary: Delete Runs
description: Delete specific runs by trace IDs.
operationId: delete_runs_api_v1_runs_delete_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Body_delete_runs_api_v1_runs_delete_post'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
components:
schemas:
RunGroupBy:
type: string
enum:
- conversation
title: RunGroupBy
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
ListRunsResponse:
properties:
runs:
items:
$ref: '#/components/schemas/RunSchema'
type: array
title: Runs
cursors:
additionalProperties:
anyOf:
- type: string
- type: 'null'
type: object
title: Cursors
search_cursors:
anyOf:
- additionalProperties:
anyOf:
- {}
- type: 'null'
type: object
- type: 'null'
title: Search Cursors
parsed_query:
anyOf:
- type: string
- type: 'null'
title: Parsed Query
type: object
required:
- runs
- cursors
title: ListRunsResponse
ThreadMessagesFormatType:
type: string
enum:
- all_messages
- human_ai_pairs
- first_human_last_ai
title: ThreadMessagesFormatType
description: Enum for thread messages format types.
RunsQueryValidationError:
properties:
field:
type: string
title: Field
message:
type: string
title: Message
type: object
required:
- field
- message
title: RunsQueryValidationError
description: A single validation error for the runs query validate endpoint.
RunRuleSpendLimitWindow:
type: string
enum:
- weekly
title: RunRuleSpendLimitWindow
Body_delete_runs_api_v1_runs_delete_post:
properties:
session_id:
type: string
format: uuid
title: Session Id
trace_ids:
items:
type: string
format: uuid
type: array
title: Trace Ids
type: object
required:
- session_id
- trace_ids
title: Body_delete_runs_api_v1_runs_delete_post
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
RunsFilterDataSourceTypeEnum:
type: string
enum:
- current
- historical
- lite
- root_lite
- runs_feedbacks_rmt_wide
title: RunsFilterDataSourceTypeEnum
description: Enum for run data source types.
RunStatsQueryParams:
properties:
id:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Id
trace:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Trace
parent_run:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Parent Run
run_type:
anyOf:
- $ref: '#/components/schemas/RunTypeEnum'
- type: 'null'
session:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Session
reference_example:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Reference Example
execution_order:
anyOf:
- type: integer
maximum: 1.0
minimum: 1.0
- type: 'null'
title: Execution Order
start_time:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Time
end_time:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Time
error:
anyOf:
- type: boolean
- type: 'null'
title: Error
query:
anyOf:
- type: string
- type: 'null'
title: Query
filter:
anyOf:
- type: string
- type: 'null'
title: Filter
trace_filter:
anyOf:
- type: string
- type: 'null'
title: Trace Filter
tree_filter:
anyOf:
- type: string
- type: 'null'
title: Tree Filter
is_root:
anyOf:
- type: boolean
- type: 'null'
title: Is Root
data_source_type:
a
# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/langchain/refs/heads/main/openapi/langchain-run-api-openapi.yml