LangChain fleet_webhooks API

The fleet_webhooks API from LangChain — 1 operation(s) for fleet_webhooks.

OpenAPI Specification

langchain-fleet-webhooks-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: LangSmith access_policies fleet_webhooks 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: fleet_webhooks
paths:
  /v1/platform/fleet-webhooks/{webhook_id}/run:
    post:
      security:
      - API Key: []
      - Tenant ID: []
      - Bearer Auth: []
      description: Sends the request payload to the webhook's stored URL and returns the upstream response in a JSON envelope.
      tags:
      - fleet_webhooks
      summary: Run a fleet webhook
      parameters:
      - description: Webhook UUID
        name: webhook_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agent_builder_webhooks.WebhookTestResult'
        '400':
          description: invalid request
          content:
            application/json:
              schema:
                type: string
        '404':
          description: webhook not found
          content:
            application/json:
              schema:
                type: string
        '502':
          description: webhook request failed
          content:
            application/json:
              schema:
                type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
components:
  schemas:
    agent_builder_webhooks.WebhookTestResult:
      type: object
      properties:
        upstream_body:
          type: string
        upstream_content_type:
          type: string
        upstream_status_code:
          type: integer
  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