The public API from LangChain — 20 operation(s) for public.
openapi: 3.1.0
info:
title: LangSmith access_policies public 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: public
paths:
/api/v1/public/{share_token}/run:
get:
tags:
- public
summary: Get Shared Run
description: Get the shared run.
operationId: get_shared_run_api_v1_public__share_token__run_get
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
- name: exclude_s3_stored_attributes
in: query
required: false
schema:
type: boolean
default: false
title: Exclude S3 Stored Attributes
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunPublicSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/run/{id}:
get:
tags:
- public
summary: Get Shared Run By Id
description: Get the shared run.
operationId: get_shared_run_by_id_api_v1_public__share_token__run__id__get
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
title: Id
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
- name: exclude_s3_stored_attributes
in: query
required: false
schema:
type: boolean
default: false
title: Exclude S3 Stored Attributes
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunPublicSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/runs/query:
post:
tags:
- public
summary: Query Shared Runs
description: Get run by ids or the shared run if not specifed.
operationId: query_shared_runs_api_v1_public__share_token__runs_query_post
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryParamsForPublicRunSchema'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListPublicRunsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/feedbacks:
get:
tags:
- public
summary: Read Shared Feedbacks
operationId: read_shared_feedbacks_api_v1_public__share_token__feedbacks_get
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
- name: run
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Run
- name: key
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Key
- name: session
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Session
- name: source
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/SourceType'
- type: 'null'
title: Source
- 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: user
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: User
- name: has_comment
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Has Comment
- name: has_score
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Has Score
- name: level
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/FeedbackLevel'
- type: 'null'
title: Level
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FeedbackSchema'
title: Response Read Shared Feedbacks Api V1 Public Share Token Feedbacks Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/datasets:
get:
tags:
- public
summary: Read Shared Dataset
description: Get dataset by ids or the shared dataset if not specifed.
operationId: read_shared_dataset_api_v1_public__share_token__datasets_get
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
- 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: sort_by
in: query
required: false
schema:
$ref: '#/components/schemas/SortByDatasetColumn'
default: last_session_start_time
- name: sort_by_desc
in: query
required: false
schema:
type: boolean
default: true
title: Sort By Desc
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetPublicSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/examples/count:
get:
tags:
- public
summary: Count Shared Examples
description: Count all examples by query params
operationId: count_shared_examples_api_v1_public__share_token__examples_count_get
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
- name: id
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Id
- name: as_of
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used.
default: latest
title: As Of
description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used.
- name: metadata
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Metadata
- name: filter
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Filter
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: integer
title: Response Count Shared Examples Api V1 Public Share Token Examples Count Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/examples:
get:
tags:
- public
summary: Read Shared Examples
description: Get example by ids or the shared example if not specifed.
operationId: read_shared_examples_api_v1_public__share_token__examples_get
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
- name: id
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Id
- name: as_of
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: string
description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used.
default: latest
title: As Of
description: Only modifications made on or before this time are included. If None, the latest version of the dataset is used.
- name: metadata
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Metadata
- 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: select
in: query
required: false
schema:
type: array
items:
$ref: '#/components/schemas/ExampleSelect'
default:
- id
- created_at
- modified_at
- name
- dataset_id
- metadata
- inputs
- outputs
- attachment_urls
title: Select
- name: filter
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Filter
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Example'
title: Response Read Shared Examples Api V1 Public Share Token Examples Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/datasets/sessions:
get:
tags:
- public
summary: Read Shared Dataset Tracer Sessions
description: Get projects run on a dataset that has been shared.
operationId: read_shared_dataset_tracer_sessions_api_v1_public__share_token__datasets_sessions_get
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
- 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: 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: facets
in: query
required: false
schema:
type: boolean
default: false
title: Facets
- 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 Shared Dataset Tracer Sessions Api V1 Public Share Token Datasets Sessions Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/datasets/sessions-bulk:
get:
tags:
- public
summary: Read Shared Dataset Tracer Sessions Bulk
description: Get sessions from multiple datasets using share tokens.
operationId: read_shared_dataset_tracer_sessions_bulk_api_v1_public_datasets_sessions_bulk_get
parameters:
- name: share_tokens
in: query
required: true
schema:
type: array
items:
type: string
title: Share Tokens
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TracerSession'
title: Response Read Shared Dataset Tracer Sessions Bulk Api V1 Public Datasets Sessions Bulk Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/examples/runs:
post:
tags:
- public
summary: Read Shared Dataset Examples With Runs
description: Get examples with associated runs from sessions in a dataset that has been shared.
operationId: read_shared_dataset_examples_with_runs_api_v1_public__share_token__examples_runs_post
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryExampleSchemaWithRuns'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/PublicExampleWithRuns'
- type: array
items:
$ref: '#/components/schemas/ExampleWithRunsCH'
title: Response Read Shared Dataset Examples With Runs Api V1 Public Share Token Examples Runs Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/datasets/runs/delta:
post:
tags:
- public
summary: Read Shared Delta
description: Fetch the number of regressions/improvements for each example in a dataset, between sessions[0] and sessions[1].
operationId: read_shared_delta_api_v1_public__share_token__datasets_runs_delta_post
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryFeedbackDelta'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SessionFeedbackDelta'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/datasets/runs/delta/stream:
post:
tags:
- public
summary: Read Shared Delta Stream
description: "Stream feedback deltas for multiple feedback keys.\n\nReturns results in chunks as they become available. Each chunk contains\nresults for one or more feedback keys. Errors for individual chunks are\nincluded in the response rather than failing the entire operation.\n\nResponse format (SSE):\n event: data\n data: {\"feedback_deltas\": {\"key1\": {session_id: {...}}, ...}, \"errors\": null}\n\n event: data\n data: {\"feedback_deltas\": {\"key2\": {...}}, \"errors\": null}\n\n event: end"
operationId: read_shared_delta_stream_api_v1_public__share_token__datasets_runs_delta_stream_post
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryFeedbackDeltaBatch'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/datasets/runs/query:
post:
tags:
- public
summary: Query Shared Dataset Runs
description: Get runs in projects run over a dataset that has been shared.
operationId: query_shared_dataset_runs_api_v1_public__share_token__datasets_runs_query_post
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BodyParamsForRunSchema'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListPublicDatasetRunsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/datasets/runs/generate-query:
post:
tags:
- public
summary: Generate Query For Shared Dataset Runs
description: Get runs in projects run over a dataset that has been shared.
operationId: generate_query_for_shared_dataset_runs_api_v1_public__share_token__datasets_runs_generate_query_post
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RequestBodyForRunsGenerateQuery'
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'
/api/v1/public/{share_token}/datasets/runs/stats:
post:
tags:
- public
summary: Stats Shared Dataset Runs
description: Get run stats in projects run over a dataset that has been shared.
operationId: stats_shared_dataset_runs_api_v1_public__share_token__datasets_runs_stats_post
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RunStatsQueryParams'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunStats'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/datasets/runs/{run_id}:
get:
tags:
- public
summary: Read Shared Dataset Run
description: Get runs in projects run over a dataset that has been shared.
operationId: read_shared_dataset_run_api_v1_public__share_token__datasets_runs__run_id__get
parameters:
- name: run_id
in: path
required: true
schema:
type: string
format: uuid
title: Run Id
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
- name: exclude_s3_stored_attributes
in: query
required: false
schema:
type: boolean
default: false
title: Exclude S3 Stored Attributes
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/RunPublicDatasetSchema'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/datasets/feedback:
get:
tags:
- public
summary: Read Shared Dataset Feedback
description: Get feedback for runs in projects run over a dataset that has been shared.
operationId: read_shared_dataset_feedback_api_v1_public__share_token__datasets_feedback_get
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
- name: run
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Run
- name: key
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Key
- name: session
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: Session
- name: source
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/SourceType'
- type: 'null'
title: Source
- 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: user
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
format: uuid
- type: 'null'
title: User
- name: has_comment
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Has Comment
- name: has_score
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Has Score
- name: level
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/FeedbackLevel'
- type: 'null'
title: Level
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FeedbackSchema'
title: Response Read Shared Dataset Feedback Api V1 Public Share Token Datasets Feedback Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/{share_token}/datasets/comparative:
get:
tags:
- public
summary: Read Shared Comparative Experiments
description: Get all comparative experiments for a given dataset.
operationId: read_shared_comparative_experiments_api_v1_public__share_token__datasets_comparative_get
parameters:
- name: share_token
in: path
required: true
schema:
type: string
format: uuid
title: Share Token
- 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: 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: sort_by
in: query
required: false
schema:
$ref: '#/components/schemas/SortByComparativeExperimentColumn'
default: created_at
- name: sort_by_desc
in: query
required: false
schema:
type: boolean
default: true
title: Sort By Desc
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PublicComparativeExperiment'
title: Response Read Shared Comparative Experiments Api V1 Public Share Token Datasets Comparative Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/schemas/{version}/message.json:
get:
tags:
- public
summary: Get Message Json Schema
operationId: get_message_json_schema_api_v1_public_schemas__version__message_json_get
parameters:
- name: version
in: path
required: true
schema:
type: string
title: Version
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/public/schemas/{version}/tooldef.json:
get:
tags:
- public
summary: Get Tool Def Json Schema
operationId: get_tool_def_json_schema_api_v1_public_schemas__version__tooldef_json_get
parameters:
- name: version
in: path
required: true
schema:
type: string
title: Version
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
SimpleExperimentInfo:
properties:
id:
type: string
format: uuid
title: Id
name:
type: string
title: Name
type: object
required:
- id
- name
title: SimpleExperimentInfo
description: Simple experiment info schema for use with comparative experiments
SessionFeedbackDelta:
properties:
feedback_deltas:
additionalProperties:
$ref: '#/components/schemas/Fee
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/langchain/refs/heads/main/openapi/langchain-public-api-openapi.yml