LangChain Organizations API

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

OpenAPI Specification

langchain-organizations-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: LangSmith access_policies Organizations 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: Organizations
paths:
  /v1/platform/orgs/current/info:
    get:
      security:
      - API Key: []
      - Organization ID: []
      - Bearer Auth: []
      description: Returns organization info for the authenticated user's current organization.
      tags:
      - Organizations
      summary: Get current organization info
      responses:
        '200':
          description: Organization info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orgs.OrganizationInfo'
        '400':
          description: Invalid organization ID
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
      parameters: []
components:
  schemas:
    orgs.OrganizationInfo:
      type: object
      properties:
        can_export_usage_backfill:
          type: boolean
        config:
          $ref: '#/components/schemas/authn.OrganizationConfig'
        default_sso_provision:
          type: boolean
        disabled:
          type: boolean
        display_name:
          type: string
        id:
          type: string
        invites_enabled:
          type: boolean
        ip_allowlist:
          type: array
          items:
            type: string
        ip_allowlist_enabled:
          type: boolean
        is_personal:
          type: boolean
        jit_provisioning_enabled:
          type: boolean
        llm_auth_proxy_allowed_urls:
          type: array
          items:
            type: string
        llm_auth_proxy_enabled:
          type: boolean
        llm_auth_proxy_jwt_audience:
          type: string
        marketplace_payouts_enabled:
          type: boolean
        max_api_key_expiry_days:
          type: integer
        max_pat_expiry_days:
          type: integer
        max_service_key_expiry_days:
          type: integer
        member_disabled:
          type: boolean
        pat_creation_disabled:
          type: boolean
        permissions:
          type: array
          items:
            type: string
        public_sharing_disabled:
          type: boolean
        reached_max_workspaces:
          type: boolean
        scim_group_name_separator:
          type: string
        security_contact:
          type: string
        sso_login_slug:
          type: string
        sso_only:
          type: boolean
        tier:
          type: string
        workspace_admin_can_invite_to_org:
          type: boolean
    authn.OrganizationConfig:
      type: object
      properties:
        agent_builder_enabled:
          description: AgentBuilderEnabled indicates whether Agent Builder is enabled for the organization.
          type: boolean
        allow_custom_iframes:
          description: AllowCustomIframes indicates whether to allow custom iframes for trace rendering.
          type: boolean
        arbitrary_cost_tracking_enabled:
          description: ArbitraryCostTrackingEnabled indicates whether arbitrary cost tracking flows are enabled
          type: boolean
        byoc_enabled:
          description: Indicates whether this org can provision BYOC data planes.
          type: boolean
        can_add_seats:
          description: CanAddSeats indicates whether this org can invite new users based on their plan.
          type: boolean
        can_disable_public_sharing:
          description: CanDisablePublicSharing indicates whether this org can disable public sharing of resources like traces, datasets, and prompts.
          type: boolean
        can_restrict_browser_secrets:
          description: CanRestrictBrowserSecrets indicates whether the org can restrict browser-level secrets in the Playground (enterprise-only).
          type: boolean
        can_set_api_key_max_expiry:
          description: CanSetApiKeyMaxExpiry indicates whether the org can set a maximum expiry duration for API keys (enterprise-only).
          type: boolean
        can_use_abac:
          description: CanUseAbac indicates whether this org can use attribute-based access control policies.
          type: boolean
        can_use_audit_logs:
          description: CanUseAuditLogs indicates whether this org can use audit logging functionality.
          type: boolean
        can_use_bulk_export:
          description: CanUseBulkExport indicates whether this org can create bulk exports.
          type: boolean
        can_use_langgraph_cloud:
          description: CanUseLanggraphCloud indicates whether this org can use LangGraph Platform.
          type: boolean
        can_use_llm_auth_proxy:
          description: CanUseLLMAuthProxy indicates whether the org can use the LLM auth proxy (enterprise-only).
          type: boolean
        can_use_rbac:
          description: CanUseRbac indicates whether this org can create new users using roles based on their plan.
          type: boolean
        can_use_saml_sso:
          description: CanUseSamlSso indicates whether this org can configure SAML SSO.
          type: boolean
        clio_enabled:
          description: CLIOEnabled indicates whether CLIO is enabled for this org.
          type: boolean
        datadog_rum_session_sample_rate:
          description: DatadogRumSessionSampleRate indicates the sampling rate for datadog RUM sessions.
          type: integer
        demo_lgp_new_graph_enabled:
          description: DemoLgpNewGraphEnabled indicates whether this org can use the demo page for creating new graphs.
          type: boolean
        enable_align_evaluators:
          description: EnableAlignEvaluators indicates whether to enable the align evaluators flow for this org.
          type: boolean
        enable_burndown_vs_commit_view:
          description: EnableBurndownVsCommitView indicates whether the org can view contract usage (burndown vs commitment).
          type: boolean
        enable_granular_usage_reporting:
          description: EnableGranularUsageReporting indicates whether the org can use granular usage reporting.
          type: boolean
        enable_include_extended_stats:
          description: EnableIncludeExtendedStats indicates whether the include extended stats checkbox should be shown in evaluator forms
          type: boolean
        enable_langgraph_pricing:
          description: EnableLanggraphPricing indicates whether to show Agent marketplace in Langgraph tab.
          type: boolean
        enable_lgp_listeners_page:
          description: EnableLgpListenersPage indicates whether the lgp listeners page should be shown
          type: boolean
        enable_markdown_in_tracing:
          description: EnableMarkdownInTracing indicates whether markdown is enabled in tracing
          type: boolean
        enable_monthly_usage_charts:
          description: EnableMonthlyUsageCharts indicates whether to show monthly organization usage charts backed by Metronome for self hosted customers
          type: boolean
        enable_org_usage_charts:
          description: EnableOrgUsageCharts indicates whether to show organization usage charts backed by ClickHouse queries instead of Metronome.
          type: boolean
        enable_pricing_redesign:
          description: EnablePricingRedesign indicates whether the pricing redesign is enabled
          type: boolean
        enable_querying_v2_endpoints:
          description: EnableQueryingV2Endpoints indicates whether to enable the querying v2 endpoints for this org.
          type: boolean
        enable_run_tree_streaming:
          description: EnableRunTreeStreaming indicates whether to enable the run tree streaming feature for this org.
          type: boolean
        enable_thread_view_playground:
          description: EnableThreadViewPlayground indicates whether to allow opening top-level thread view runs in the playground.
          type: boolean
        enable_threads_improvements:
          description: EnableThreadsImprovements indicates whether to enable the threads improvements feature for this org.
          type: boolean
        ip_allowlist_enabled:
          description: 'IPAllowlistEnabled indicates whether this org can configure and enforce IP allowlists.

            Set by Metronome entitlement, not admin-patchable.'
          type: boolean
        kv_dataset_message_support:
          description: KvDatasetMessageSupport indicates whether to use the new messages experience for KV datasets.
          type: boolean
        langgraph_deploy_own_cloud_enabled:
          description: LangGraphDeployOwnCloudEnabled indicates whether the org can deploy LangGraph cloud to their own cloud.
          type: boolean
        langgraph_enterprise_enabled:
          description: LangGraphEnterpriseEnabled indicates whether the org has access to LangGraph Enterprise features.
          type: boolean
        langgraph_remote_reconciler_enabled:
          description: LangGraphRemoteReconcilerEnabled indicates whether an org's LangGraph deployments are reconciled via a remote reconciler instance.
          type: boolean
        langsmith_alerts_poc_enabled:
          description: LangsmithAlertsPocEnabled indicates whether to enable the legacy alerts POC for this org.
          type: boolean
        langsmith_deployment_distributed_runtime_enabled:
          description: LangSmithDeploymentDistributedRuntimeEnabled indicates whether distributed runtime is enabled for the organization.
          type: boolean
        langsmith_deployment_dr_enabled_dev:
          type: boolean
        lgp_templates_enabled:
          description: LgpTemplatesEnabled indicates whether to enable LGP templates for this org.
          type: boolean
        llm_gateway_enabled:
          description: 'LLMGatewayEnabled indicates whether this org can use the LLM Gateway

            (admin UI and gateway policies).'
          type: boolean
        max_agent_builder_assistants:
          description: MaxAgentBuilderAssistants is the maximum number of Agent Builder assistants allowed for this org.
          type: integer
        max_agent_builder_runs:
          description: 'MaxAgentBuilderRuns is the maximum number of Agent Builder runs per month.

            Default is -1 (unlimited). Set to a positive value for a specific limit.'
          type: integer
        max_free_langgraph_cloud_deployments:
          description: MaxFreeLanggraphCloudDeployments is the maximum number of free LangGraph Platform deployments allowed for this org.
          type: integer
        max_identities:
          description: MaxIdentities is the maximum number of identities allowed in this org.
          type: integer
        max_langgraph_cloud_deployments:
          description: MaxLanggraphCloudDeployments is the maximum number of LangGraph Platform deployments allowed for this org.
          type: integer
        max_prompt_webhooks:
          description: MaxPromptWebhooks is the maximum number of prompt webhooks allowed for this org.
          type: integer
        max_sandbox_cpu:
          description: MaxSandboxCpu is the total CPU cores allowed for sandboxes (e.g., "4", "8").
          type: string
        max_sandbox_memory:
          description: MaxSandboxMemory is the total memory allowed for sandboxes (e.g., "8Gi", "16Gi").
          type: string
        max_sandbox_storage:
          description: MaxSandboxStorage is the total volume storage allowed for sandboxes (e.g., "10Gi", "50Gi").
          type: string
        max_sandbox_volumes:
          description: MaxSandboxVolumes is the maximum number of sandbox volumes allowed for this org.
          type: integer
        max_sandboxes:
          description: MaxSandboxes is the maximum number of sandbox claims allowed for this org.
          type: integer
        max_workspaces:
          description: MaxWorkspaces is the maximum number of workspaces allowed in this org. -1 means no limit.
          type: integer
        new_rule_evaluator_creation_version:
          description: New Evaluator Version
          type: integer
        plan_tier:
          description: 'PlanTier is the organization''s payment plan tier (e.g., "free", "developer", "plus", "enterprise").

            Populated from Metronome''s __tier custom field during auth verification.'
          type: string
        playground_evaluator_strategy:
          description: 'PlaygroundEvaluatorStrategy indicates the method of running evaluators in the playground

            options are "cron", "background", or "sync"'
          type: string
        premier_plan_approval_date:
          description: PremierPlanApprovalDate is the date when the org was approved for the premier plan in YYYY-MM-DD format.
          type: string
        prompt_optimization_jobs_enabled:
          description: PromptOptimizationJobsEnabled indicates whether the org can use the prompt optimization jobs feature.
          type: boolean
        show_playground_prompt_canvas:
          description: ShowPlaygroundPromptCanvas indicates whether to show the playground prompt canvas.
          type: boolean
        show_updated_resource_tags:
          description: ShowUpdatedResourceTags indicates whether to show updated resource tags to users in this org.
          type: boolean
        show_updated_sidenav:
          description: ShowUpdatedSidenav indicates whether to show updated side nav to users in this org.
          type: boolean
        startup_plan_approval_date:
          description: StartupPlanApprovalDate is the date when the org was approved for the startup plan in YYYY-MM-DD format.
          type: string
        tenant_skip_topk_facets:
          description: TenantSkipTopkFacets indicates whether the tenant should skip topk facets in run stats.
          type: boolean
        use_exact_search_for_prompts:
          description: UseExactSearchForPrompts indicates whether to use exact search for prompts.
          type: boolean
  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