LangChain features API

The features API from LangChain — 4 operation(s) for features.

OpenAPI Specification

langchain-features-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: LangSmith access_policies features 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: features
paths:
  /v1/platform/features:
    get:
      security:
      - API Key: []
      - Tenant ID: []
      - Bearer Auth: []
      description: Returns a consolidated view of default models and disabled models per feature for the workspace.
      tags:
      - features
      summary: List feature configurations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/features.FeatureConfig'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
      parameters: []
  /v1/platform/features/{feature}/default-model:
    put:
      security:
      - API Key: []
      - Tenant ID: []
      - Bearer Auth: []
      description: Sets or replaces the default model for a feature in the workspace.
      tags:
      - features
      summary: Set default model for a feature
      parameters:
      - description: Feature name
        name: feature
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/features.UpsertDefaultModelRequest'
    delete:
      security:
      - API Key: []
      - Tenant ID: []
      - Bearer Auth: []
      description: Removes the default model for a feature in the workspace.
      tags:
      - features
      summary: Delete default model for a feature
      parameters:
      - description: Feature name
        name: feature
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
  /v1/platform/features/{feature}/disabled-models:
    put:
      security:
      - API Key: []
      - Tenant ID: []
      - Bearer Auth: []
      description: Adds a model to the disabled list for a feature in the workspace.
      tags:
      - features
      summary: Disable a model for a feature
      parameters:
      - description: Feature name
        name: feature
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/features.DisableModelRequest'
  /v1/platform/features/{feature}/disabled-models/{model}:
    delete:
      security:
      - API Key: []
      - Tenant ID: []
      - Bearer Auth: []
      description: Removes a model from the disabled list for a feature in the workspace.
      tags:
      - features
      summary: Re-enable a disabled model for a feature
      parameters:
      - description: Feature name
        name: feature
        in: path
        required: true
        schema:
          type: string
      - description: Model name (URL-encoded)
        name: model
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/features.ErrorResponse'
components:
  schemas:
    features.ErrorResponse:
      type: object
      properties:
        error:
          type: string
    features.UpsertDefaultModelRequest:
      type: object
      properties:
        model:
          type: string
    features.FeatureConfig:
      type: object
      properties:
        default_model:
          type: string
        disabled_models:
          type: array
          items:
            type: string
        feature:
          type: string
    features.DisableModelRequest:
      type: object
      properties:
        model:
          type: string
  securitySchemes:
    API Key:
      type: apiKey
      in: header
      name: X-API-Key
    Tenant ID:
      type: apiKey
      in: header
      name: X-Tenant-Id
    Bearer Auth:
      type: http
      description: Bearer tokens are used to authenticate from the UI. Must also specify x-tenant-id or x-organization-id (for org scoped apis).
      scheme: bearer
    Organization ID:
      type: apiKey
      in: header
      name: X-Organization-Id