openapi: 3.1.0
info:
  title: LangSmith access_policies audit-logs 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: audit-logs
paths:
  /api/v1/audit-logs:
    get:
      tags:
      - audit-logs
      summary: Get Audit Logs
      description: 'Retrieve audit log records for the authenticated user''s organization in OCSF format.


        Requires both start_time and end_time parameters to filter logs within a date range.

        Supports cursor-based pagination.


        Returns results in OCSF API Activity (Class UID: 6003) format,

        which is compatible with security monitoring and SIEM tools.

        Reference: https://schema.ocsf.io/1.7.0/classes/api_activity'
      operationId: get_audit_logs_api_v1_audit_logs_get
      security:
      - API Key: []
      - Organization ID: []
      - Bearer Auth: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Number of items to return
          default: 10
          title: Limit
        description: Number of items to return
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor for pagination (base64-encoded JSON string)
          title: Cursor
        description: Cursor for pagination (base64-encoded JSON string)
      - name: workspace_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          description: Filter by workspace ID
          title: Workspace Id
        description: Filter by workspace ID
      - name: start_time
        in: query
        required: true
        schema:
          type: string
          format: date-time
          description: Start datetime (inclusive) in ISO 8601 format
          title: Start Time
        description: Start datetime (inclusive) in ISO 8601 format
      - name: end_time
        in: query
        required: true
        schema:
          type: string
          format: date-time
          description: End datetime (inclusive) in ISO 8601 format
          title: End Time
        description: End datetime (inclusive) in ISO 8601 format
      - name: operations
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              $ref: '#/components/schemas/AuditLogOperation'
          - type: 'null'
          description: Filter by operation names. If omitted, all operations are returned.
          title: Operations
        description: Filter by operation names. If omitted, all operations are returned.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAuditLogsOCSFResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    OCSFHttpResponse:
      properties:
        code:
          anyOf:
          - type: integer
          - type: 'null'
          title: Code
      type: object
      required:
      - code
      title: OCSFHttpResponse
      description: OCSF HTTP response object.
    OCSFCategoryUid:
      type: integer
      enum:
      - 6
      title: OCSFCategoryUid
      description: OCSF category UIDs.
    OCSFActor:
      properties:
        user:
          $ref: '#/components/schemas/OCSFUser'
      type: object
      required:
      - user
      title: OCSFActor
      description: OCSF actor object.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    AuditLogOperation:
      type: string
      enum:
      - create_api_key
      - delete_api_key
      - create_personal_access_token
      - delete_personal_access_token
      - create_service_key
      - delete_service_key
      - create_role
      - update_role
      - delete_role
      - invite_user_to_org
      - invite_users_to_org_batch
      - add_basic_auth_users_to_org
      - update_basic_auth_user
      - delete_org_pending_member
      - delete_org_member
      - update_org_member
      - create_sso_settings
      - update_sso_settings
      - delete_sso_settings
      - update_default_sso_provision_organization
      - update_login_methods
      - update_organization_info
      - update_business_info
      - update_payment_plan
      - update_payment_method
      - create_payment_setup_intent
      - create_payment_checkout_session
      - confirm_payment_checkout_session
      - create_payment_account_link
      - create_workspace
      - update_workspace
      - delete_workspace
      - add_member_to_workspace
      - add_members_to_workspace_batch
      - delete_workspace_member
      - update_workspace_member
      - delete_workspace_pending_member
      - update_workspace_secrets
      - unshare_entities
      - set_tenant_handle
      - create_tag_key
      - update_tag_key
      - delete_tag_key
      - create_tag_value
      - update_tag_value
      - delete_tag_value
      - create_tagging
      - delete_tagging
      - update_tracer_session
      - delete_tracer_session
      - delete_tracer_sessions
      - delete_runs
      - create_dataset
      - create_csv_dataset
      - create_experiment_via_upload
      - create_playground_experiment
      - create_comparative_experiment
      - delete_comparative_experiment
      - delete_dataset
      - delete_datasets
      - update_dataset
      - update_dataset_version
      - update_dataset_splits
      - share_dataset
      - unshare_dataset
      - clone_dataset
      - download_dataset
      - create_example
      - create_examples
      - update_example
      - update_examples
      - sync_examples
      - delete_example
      - delete_examples
      - create_bulk_export
      - cancel_bulk_export
      - read_bulk_export_destination
      - create_bulk_export_destination
      - update_bulk_export_destination
      - update_ttl_settings
      - update_usage_limit
      - delete_usage_limit
      - create_model_price_map
      - update_model_price_map
      - delete_model_price_map
      - create_chart
      - update_chart
      - delete_chart
      - create_chart_section
      - update_chart_section
      - delete_chart_section
      - clone_chart_section
      - create_org_chart
      - update_org_chart
      - delete_org_chart
      - create_org_chart_section
      - update_org_chart_section
      - delete_org_chart_section
      - create_prompt_webhook
      - update_prompt_webhook
      - delete_prompt_webhook
      - test_prompt_webhook
      - create_deployment
      - update_deployment
      - delete_deployment
      - create_access_policy
      - delete_access_policy
      - list_access_policies
      - read_access_policy
      - attach_access_policies
      - read_role_access_policies
      - create_scim_token
      - update_scim_token
      - delete_scim_token
      - create_scim_user
      - update_scim_user
      - delete_scim_user
      - create_scim_group
      - update_scim_group
      - delete_scim_group
      - create_prompt_canvas_quick_action
      - update_prompt_canvas_quick_action
      - delete_prompt_canvas_quick_action
      - create_fleet_usage_limit
      - update_fleet_usage_limit
      - delete_fleet_usage_limit
      - create_experiment_view_override
      - update_experiment_view_override
      - delete_experiment_view_override
      - create_alert_rule
      - update_alert_rule
      - delete_alert_rule
      - test_alert_rule
      - create_forge_configuration
      - update_forge_configuration
      - delete_forge_configuration
      - trigger_forge_configuration
      - add_annotation_queue_reviewer
      - remove_annotation_queue_reviewer
      - submit_nps_response
      - create_mcp_server
      - update_mcp_server
      - delete_mcp_server
      - register_mcp_server_oauth
      - create_tool
      - update_tool
      - delete_tool
      - create_mcp_vendor_settings
      - update_mcp_vendor_settings
      - delete_mcp_vendor_settings
      - create_evaluator
      - update_evaluator
      - delete_evaluator
      - bulk_delete_evaluators
      - upsert_feature_default_model
      - delete_feature_default_model
      - upsert_feature_disabled_model
      - delete_feature_disabled_model
      - create_fleet_webhook
      - update_fleet_webhook
      - delete_fleet_webhook
      - test_fleet_webhook
      - create_commit
      - create_hub_environment
      - update_hub_environment
      - delete_hub_environment
      - create_directory_commit
      - delete_directory
      - create_gateway_policy
      - update_gateway_policy
      - delete_gateway_policy
      - create_sandbox_proxy_profile
      - update_sandbox_proxy_profile
      - delete_sandbox_proxy_profile
      - create_annotation_queue
      - populate_annotation_queue
      - delete_annotation_queue
      - delete_annotation_queues
      - update_annotation_queue
      - add_runs_to_annotation_queue
      - export_annotation_queue
      - update_annotation_queue_run
      - delete_annotation_queue_run
      - delete_annotation_queue_runs
      - create_annotation_queue_run_status
      - login
      - send_sso_email_confirmation
      - confirm_sso_user_email
      - execute_custom_code
      - generate_dataset
      - evaluate_experiment
      - create_feedback_formula
      - update_feedback_formula
      - delete_feedback_formula
      - create_feedback_config
      - update_feedback_config
      - delete_feedback_config
      - invalidate_mcp_tools_cache
      - mcp_proxy
      - create_onboarding_state
      - update_onboarding_state
      - create_organization
      - delete_pending_organization_invite
      - claim_pending_organization_invite
      - create_playground_settings
      - update_playground_settings
      - delete_playground_settings
      - create_service_account
      - delete_service_account
      - create_tenant
      - create_filter_view
      - update_filter_view
      - rename_filter_view
      - delete_filter_view
      - create_insights_job
      - create_insights_job_config
      - update_insights_job_config
      - delete_insights_job_config
      - update_insights_job
      - delete_insights_job
      - read_charts
      - read_chart_preview
      - read_chart
      - read_chart_section
      - validate_example
      - validate_examples
      - read_shared_delta
      - read_shared_delta_stream
      - generate_shared_dataset_query
      - generate_runs_query
      - read_tracing_dashboard
      - generate_insights_job_config
      - read_dataset_delta
      - delete_pending_workspace_invite
      - claim_pending_workspace_invite
      - list_annotation_queues
      - get_annotation_queue
      - get_annotation_queue_runs
      - get_annotation_queue_run
      - get_annotation_queues_for_run
      - get_annotation_queue_size
      - get_annotation_queue_archived_size
      - get_annotation_queue_total_size
      - resolve_annotation_queue_run
      - get_audit_logs
      - get_sso_settings
      - list_bulk_exports
      - list_bulk_export_destinations
      - get_bulk_export
      - get_bulk_export_runs
      - get_bulk_export_run
      - get_bulk_export_runs_filtered
      - list_chart_sections
      - get_dataset_versions
      - diff_dataset_versions
      - get_dataset_version
      - read_dataset_share_state
      - count_examples
      - list_feedback_formulas
      - get_feedback_formula
      - list_feedback_configs
      - get_mcp_tools
      - mcp_proxy_get
      - get_onboarding_state
      - read_model_price_map
      - list_organizations
      - get_organization_info
      - get_organization_billing_info
      - get_org_dashboard
      - get_company_info
      - list_organization_roles
      - list_permissions
      - list_pending_organization_invites
      - list_org_members
      - get_org_usage
      - get_granular_usage
      - export_granular_usage_csv
      - export_usage_backfill_csv
      - get_login_methods
      - get_sso_settings_current
      - list_org_service_keys
      - list_org_personal_access_tokens
      - list_service_accounts
      - list_filter_views
      - get_filter_view
      - list_insights_jobs
      - list_insights_job_configs
      - get_insights_job
      - get_insights_job_runs
      - get_run_cluster
      - get_usage_limits
      - get_org_usage_limits
      - list_workspaces
      - list_pending_workspace_invites
      - get_workspace_stats
      - list_workspace_members
      - get_shared_tokens
      - get_workspace_usage_limits_info
      - list_tag_keys
      - get_tag_key
      - list_tag_values
      - get_tag_value
      - list_tags
      - list_tags_for_resource
      - list_taggings
      - get_shared_examples_count
      - list_examples
      - get_example
      - get_experiment_view_overrides
      - get_experiment_view_override
      - get_dataset_comparison_view
      - stream_dataset_comparison_view
      - stream_feedback_delta
      - query_run
      - query_runs
      - query_trace
      - query_trace_messages
      - batch_query_trace_messages
      - query_thread_traces
      - query_threads
      - list_pairwise_queues
      - get_pairwise_queue
      - list_pairwise_entries
      - read_run
      - read_runs
      - read_example
      - read_examples
      - read_feedback
      - read_feedbacks
      - create_license_share_link
      - create_provisioned_saas_org
      - mint_self_hosted_license
      - invite_provisioned_org_member
      - create_self_hosted_customer
      - update_self_hosted_customer
      - update_self_hosted_license
      title: AuditLogOperation
      description: Operations that are logged in audit_logs database table.
    OCSFSeverityId:
      type: integer
      enum:
      - 99
      title: OCSFSeverityId
      description: Severity levels for OCSF events.
    OCSFMetadata:
      properties:
        uid:
          type: string
          format: uuid
          title: Uid
        product:
          $ref: '#/components/schemas/OCSFProduct'
      type: object
      required:
      - uid
      - product
      title: OCSFMetadata
      description: OCSF event metadata.
    OCSFActivityId:
      type: integer
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 99
      title: OCSFActivityId
      description: Activity types for API Activity class.
    OCSFUser:
      properties:
        uid:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Uid
        credential_uid:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Credential Uid
      type: object
      required:
      - uid
      - credential_uid
      title: OCSFUser
      description: OCSF user object within actor.
    OCSFClassName:
      type: string
      enum:
      - API Activity
      title: OCSFClassName
      description: OCSF class names.
    OCSFProduct:
      properties:
        name:
          type: string
          title: Name
        vendor_name:
          type: string
          title: Vendor Name
      type: object
      required:
      - name
      - vendor_name
      title: OCSFProduct
      description: OCSF product object.
    OCSFApiActivity:
      properties:
        class_uid:
          $ref: '#/components/schemas/OCSFClassUid'
        class_name:
          $ref: '#/components/schemas/OCSFClassName'
        category_uid:
          $ref: '#/components/schemas/OCSFCategoryUid'
        category_name:
          $ref: '#/components/schemas/OCSFCategoryName'
        severity_id:
          $ref: '#/components/schemas/OCSFSeverityId'
        type_uid:
          $ref: '#/components/schemas/OCSFTypeUid'
        activity_id:
          $ref: '#/components/schemas/OCSFActivityId'
        activity_name:
          type: string
          title: Activity Name
        status_id:
          $ref: '#/components/schemas/OCSFStatusId'
        status:
          type: string
          title: Status
        time:
          type: integer
          title: Time
        metadata:
          $ref: '#/components/schemas/OCSFMetadata'
        api:
          $ref: '#/components/schemas/OCSFApi'
        http_request:
          $ref: '#/components/schemas/OCSFHttpRequest'
        http_response:
          $ref: '#/components/schemas/OCSFHttpResponse'
        actor:
          $ref: '#/components/schemas/OCSFActor'
        src_endpoint:
          $ref: '#/components/schemas/OCSFEndpoint'
        resources:
          items:
            $ref: '#/components/schemas/OCSFResourceDetails'
          type: array
          title: Resources
        unmapped:
          $ref: '#/components/schemas/OCSFUnmapped'
      type: object
      required:
      - class_uid
      - class_name
      - category_uid
      - category_name
      - severity_id
      - type_uid
      - activity_id
      - activity_name
      - status_id
      - status
      - time
      - metadata
      - api
      - http_request
      - http_response
      - actor
      - src_endpoint
      - resources
      - unmapped
      title: OCSFApiActivity
      description: 'OCSF API Activity event (Class UID: 6003).


        This represents an API call event in the OCSF format.

        Reference: https://schema.ocsf.io/1.7.0/classes/api_activity


        Remember to try to validate the OCSF event against the official OCSF schema validator API: https://schema.ocsf.io/doc/index.html#/Tools/SchemaWeb.SchemaController.validate

        Or with `test_ocsf_validates_against_schema()` in test_audit_logs_models.py.'
    AuditLogMessage:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        operation_name:
          type: string
          title: Operation Name
        operation_succeeded:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Operation Succeeded
        request_time:
          type: string
          format: date-time
          title: Request Time
        api_key_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Api Key Id
        user_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: User Id
        ls_user_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Ls User Id
        organization_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
        workspace_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Workspace Id
        enrichments:
          anyOf:
          - $ref: '#/components/schemas/AuditLogEnrichments'
          - type: 'null'
      type: object
      required:
      - id
      - operation_name
      - operation_succeeded
      - request_time
      - api_key_id
      - user_id
      - ls_user_id
      - organization_id
      - workspace_id
      - enrichments
      title: AuditLogMessage
      description: 'Represents an audit log message.


        Indexed columns are individual DB columns. All other fields

        (request_method, request_path, client_host, etc.) live in the

        enrichments JSONB column.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ListAuditLogsOCSFResponse:
      properties:
        cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
        items:
          items:
            $ref: '#/components/schemas/OCSFApiActivity'
          type: array
          title: Items
      type: object
      required:
      - cursor
      - items
      title: ListAuditLogsOCSFResponse
      description: Response model for listing audit logs in OCSF format with pagination.
    OCSFStatusId:
      type: integer
      enum:
      - 0
      - 1
      - 2
      - 99
      title: OCSFStatusId
      description: Status values for OCSF events.
    OCSFEndpoint:
      properties:
        ip:
          anyOf:
          - type: string
          - type: 'null'
          title: Ip
        port:
          anyOf:
          - type: integer
          - type: 'null'
          title: Port
        intermediate_ips:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Intermediate Ips
      type: object
      required:
      - ip
      - port
      - intermediate_ips
      title: OCSFEndpoint
      description: OCSF network endpoint object.
    OCSFHttpRequest:
      properties:
        http_method:
          type: string
          title: Http Method
        url:
          $ref: '#/components/schemas/OCSFUrl'
      type: object
      required:
      - http_method
      - url
      title: OCSFHttpRequest
      description: OCSF HTTP request object.
    AuditLogEnrichments:
      properties:
        request_method:
          type: string
          title: Request Method
        request_path:
          type: string
          title: Request Path
        client_host:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Host
        client_port:
          anyOf:
          - type: integer
          - type: 'null'
          title: Client Port
        x_forwarded_for:
          anyOf:
          - type: string
          - type: 'null'
          title: X Forwarded For
        response_status_code:
          anyOf:
          - type: integer
          - type: 'null'
          title: Response Status Code
        resource_ids:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Resource Ids
      type: object
      title: AuditLogEnrichments
      description: Non-indexed request metadata stored in the enrichments JSONB column.
    OCSFCategoryName:
      type: string
      enum:
      - Application Activity
      title: OCSFCategoryName
      description: OCSF category names.
    OCSFUnmapped:
      properties:
        original_audit_log:
          $ref: '#/components/schemas/AuditLogMessage'
      type: object
      required:
      - original_audit_log
      title: OCSFUnmapped
      description: 'OCSF unmapped attribute for source-specific data.


        Reference: https://schema.ocsf.io/1.7.0/classes/base_event'
    OCSFTypeUid:
      type: integer
      enum:
      - 600300
      - 600301
      - 600302
      - 600303
      - 600304
      - 600399
      title: OCSFTypeUid
      description: OCSF type UIDs for API Activity (class_uid * 100 + activity_id).
    OCSFClassUid:
      type: integer
      enum:
      - 6003
      title: OCSFClassUid
      description: OCSF class UIDs.
    OCSFResourceDetails:
      properties:
        uid:
          type: string
          format: uuid
          title: Uid
      type: object
      required:
      - uid
      title: OCSFResourceDetails
      description: OCSF resource details object.
    OCSFUrl:
      properties:
        path:
          type: string
          title: Path
      type: object
      required:
      - path
      title: OCSFUrl
      description: OCSF URL object.
    OCSFApi:
      properties:
        operation:
          $ref: '#/components/schemas/AuditLogOperation'
      type: object
      required:
      - operation
      title: OCSFApi
      description: OCSF API details object.
  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