LangSmith beacon API

openapi: 3.1.0
info:
  title: LangSmith access_policies beacon 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: beacon
paths:
  /v1/beacon/usage-snapshot:
    post:
      security:
      - API Key: []
      - Tenant ID: []
      - Bearer Auth: []
      description: 'Records aggregate entity counts (workspaces, projects, datasets, active users, etc.)

        from a self-hosted deployment. Called daily by installs where PHONE_HOME_ENABLED

        and PHONE_HOME_USAGE_REPORTING_ENABLED are set. Authenticates via license key.'
      tags:
      - beacon
      summary: Submit a self-hosted usage snapshot
      parameters: []
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/beacon.SubmitUsageSnapshotPayload'
components:
  schemas:
    beacon.SubmitUsageSnapshotPayload:
      type: object
      properties:
        from_timestamp:
          type: string
        license_key:
          type: string
        measures:
          type: object
          additionalProperties:
            type: integer
        to_timestamp:
          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