The tracer-sessions API from LangChain — 14 operation(s) for tracer-sessions.
openapi: 3.1.0
info:
title: LangSmith access_policies tracer-sessions 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: tracer-sessions
paths:
/api/v1/sessions/{session_id}/dashboard:
post:
tags:
- tracer-sessions
summary: Get Tracing Project Prebuilt Dashboard
description: Get a prebuilt dashboard for a tracing project.
operationId: get_tracing_project_prebuilt_dashboard_api_v1_sessions__session_id__dashboard_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: accept
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Accept
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomChartsSectionRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomChartsSection'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}:
get:
tags:
- tracer-sessions
summary: Read Tracer Session
description: Get a specific session.
operationId: read_tracer_session_api_v1_sessions__session_id__get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: include_stats
in: query
required: false
schema:
type: boolean
default: false
title: Include Stats
- name: stats_start_time
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Stats Start Time
- name: accept
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Accept
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TracerSession'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- tracer-sessions
summary: Update Tracer Session
description: Update a session.
operationId: update_tracer_session_api_v1_sessions__session_id__patch
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TracerSessionUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TracerSessionWithoutVirtualFields'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- tracer-sessions
summary: Delete Tracer Session
description: Delete a specific session.
operationId: delete_tracer_session_api_v1_sessions__session_id__delete
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions:
get:
tags:
- tracer-sessions
summary: Read Tracer Sessions
description: Get all sessions.
operationId: read_tracer_sessions_api_v1_sessions_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: reference_free
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Reference Free
- name: reference_dataset
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Reference Dataset
- name: id
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Id
- name: name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name
- name: name_contains
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Name Contains
- name: dataset_version
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Dataset Version
- name: sort_by
in: query
required: false
schema:
$ref: '#/components/schemas/SessionSortableColumns'
default: start_time
- name: sort_by_desc
in: query
required: false
schema:
type: boolean
default: true
title: Sort By Desc
- name: metadata
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Metadata
- name: sort_by_feedback_key
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Sort By Feedback Key
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 100
title: Limit
- name: tag_value_id
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Tag Value Id
- name: facets
in: query
required: false
schema:
type: boolean
default: false
title: Facets
- name: filter
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Filter
- name: include_stats
in: query
required: false
schema:
type: boolean
default: false
title: Include Stats
- name: use_approx_stats
in: query
required: false
schema:
type: boolean
default: false
title: Use Approx Stats
- name: stats_start_time
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Stats Start Time
- name: stats_select
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Stats Select
- name: accept
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Accept
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TracerSession'
title: Response Read Tracer Sessions Api V1 Sessions Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- tracer-sessions
summary: Create Tracer Session
description: Create a new session.
operationId: create_tracer_session_api_v1_sessions_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: upsert
in: query
required: false
schema:
type: boolean
default: false
title: Upsert
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TracerSessionCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TracerSessionWithoutVirtualFields'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- tracer-sessions
summary: Delete Tracer Sessions
description: Delete sessions.
operationId: delete_tracer_sessions_api_v1_sessions_delete
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_ids
in: query
required: true
schema:
type: array
items:
type: string
format: uuid
title: Session Ids
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}/metadata:
get:
tags:
- tracer-sessions
summary: Read Tracer Sessions Runs Metadata
description: Given a session, a number K, and (optionally) a list of metadata keys, return the top K values for each key.
operationId: read_tracer_sessions_runs_metadata_api_v1_sessions__session_id__metadata_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: metadata_keys
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Metadata Keys
- name: start_time
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Time
- name: k
in: query
required: false
schema:
type: integer
minimum: 1
default: 10
title: K
- name: root_runs_only
in: query
required: false
schema:
type: boolean
default: false
title: Root Runs Only
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RootModel_Dict_str__list_str___'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}/views:
get:
tags:
- tracer-sessions
summary: Read Filter Views
description: Get all filter views for a session.
operationId: read_filter_views_api_v1_sessions__session_id__views_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: type
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/FilterViewType'
- type: 'null'
title: Type
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FilterView'
title: Response Read Filter Views Api V1 Sessions Session Id Views Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- tracer-sessions
summary: Create Filter View
description: Create a new filter view.
operationId: create_filter_view_api_v1_sessions__session_id__views_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FilterViewCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FilterView'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}/views/{view_id}:
get:
tags:
- tracer-sessions
summary: Read Filter View
description: Get a specific filter view.
operationId: read_filter_view_api_v1_sessions__session_id__views__view_id__get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: view_id
in: path
required: true
schema:
type: string
format: uuid
title: View Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FilterView'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- tracer-sessions
summary: Update Filter View
description: Update a filter view.
operationId: update_filter_view_api_v1_sessions__session_id__views__view_id__patch
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: view_id
in: path
required: true
schema:
type: string
format: uuid
title: View Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FilterViewUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FilterView'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- tracer-sessions
summary: Delete Filter View
description: Delete a specific filter view.
operationId: delete_filter_view_api_v1_sessions__session_id__views__view_id__delete
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: view_id
in: path
required: true
schema:
type: string
format: uuid
title: View Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}/views/{view_id}/rename:
patch:
tags:
- tracer-sessions
summary: Rename Filter View
description: Rename a filter view (display_name and description only).
operationId: rename_filter_view_api_v1_sessions__session_id__views__view_id__rename_patch
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: view_id
in: path
required: true
schema:
type: string
format: uuid
title: View Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FilterViewRename'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FilterView'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}/insights:
get:
tags:
- tracer-sessions
summary: '[Beta] Get Insights Jobs'
description: Get all clusters for a session.
operationId: _Beta__Get_Insights_Jobs_api_v1_sessions__session_id__insights_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 100
title: Limit
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: config_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Config Id
- name: legacy
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Legacy
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GetRunClusteringJobsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- tracer-sessions
summary: '[Beta] Create Insights Job'
description: Create an insights job.
operationId: _Beta__Create_Insights_Job_api_v1_sessions__session_id__insights_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRunClusteringJobRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRunClusteringJobResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}/insights/configs:
get:
tags:
- tracer-sessions
summary: '[Beta] Get Insights Job Configs'
description: Get all insights job configs for a session.
operationId: _Beta__Get_Insights_Job_Configs_api_v1_sessions__session_id__insights_configs_get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: include_prebuilts
in: query
required: false
schema:
type: boolean
default: false
title: Include Prebuilts
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GetClusteringJobConfigsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- tracer-sessions
summary: '[Beta] Create Insights Job Config'
description: Save an insights job config.
operationId: _Beta__Create_Insights_Job_Config_api_v1_sessions__session_id__insights_configs_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateClusteringJobConfigRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CreateClusteringJobConfigResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}/insights/configs/generate:
post:
tags:
- tracer-sessions
summary: '[Beta] Auto-Generate Insights Job Config'
description: Auto-generate an insights job config.
operationId: _Beta__Auto_Generate_Insights_Job_Config_api_v1_sessions__session_id__insights_configs_generate_post
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateClusteringJobConfigRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateClusteringJobConfigResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}/insights/configs/{config_id}:
patch:
tags:
- tracer-sessions
summary: '[Beta] Update Insights Job Config'
description: Update an insights job config.
operationId: _Beta__Update_Insights_Job_Config_api_v1_sessions__session_id__insights_configs__config_id__patch
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: config_id
in: path
required: true
schema:
type: string
format: uuid
title: Config Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateClusteringJobConfigRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CreateClusteringJobConfigResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- tracer-sessions
summary: '[Beta] Delete Insights Job Config'
description: Delete an insights job config.
operationId: _Beta__Delete_Insights_Job_Config_api_v1_sessions__session_id__insights_configs__config_id__delete
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: config_id
in: path
required: true
schema:
type: string
format: uuid
title: Config Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteClusteringJobConfigResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}/insights/{job_id}:
get:
tags:
- tracer-sessions
summary: '[Beta] Get Insights Job'
description: Get a specific cluster job for a session.
operationId: _Beta__Get_Insights_Job_api_v1_sessions__session_id__insights__job_id__get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: job_id
in: path
required: true
schema:
type: string
format: uuid
title: Job Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GetRunClusteringJobResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- tracer-sessions
summary: '[Beta] Update Insights Job'
description: Update a session cluster job.
operationId: _Beta__Update_Insights_Job_api_v1_sessions__session_id__insights__job_id__patch
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: job_id
in: path
required: true
schema:
type: string
format: uuid
title: Job Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRunClusteringJobRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRunClusteringJobResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- tracer-sessions
summary: '[Beta] Delete Insights Job'
description: Delete a session cluster job.
operationId: _Beta__Delete_Insights_Job_api_v1_sessions__session_id__insights__job_id__delete
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name: job_id
in: path
required: true
schema:
type: string
format: uuid
title: Job Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteRunClusteringJobResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/sessions/{session_id}/insights/{job_id}/clusters/{cluster_id}:
get:
tags:
- tracer-sessions
summary: '[Beta] Get Run Cluster From Insights Job'
description: Get a specific cluster for a session.
operationId: _Beta__Get_Run_Cluster_from_Insights_Job_api_v1_sessions__session_id__insights__job_id__clusters__cluster_id__get
security:
- API Key: []
- Tenant ID: []
- Bearer Auth: []
parameters:
- name: session_id
in: path
required: true
schema:
type: string
format: uuid
title: Session Id
- name:
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/langchain/refs/heads/main/openapi/langchain-tracer-sessions-api-openapi.yml