> ## Documentation Index
> Fetch the complete documentation index at: https://tbd-6fc993ce-hypeship-stagehand-v4-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get organization entitlements

> Get the authenticated organization's effective feature access and constraints after applying its plan, active trial treatment, plan status, and organization-specific overrides. Null constraint values mean unlimited.



## OpenAPI

````yaml https://api.onkernel.com/spec.json get /org/entitlements
openapi: 3.1.0
info:
  description: Developer tools and cloud infrastructure for AI agents to use web browsers
  title: Kernel API
  version: 0.1.0
servers:
  - description: API Server
    url: https://api.onkernel.com
security:
  - bearerAuth: []
tags:
  - description: Create and manage browser sessions.
    name: Browsers
  - description: Control mouse, keyboard, and screen on the browser instance.
    name: Browser Computer Controls
  - description: Execute Playwright code against the browser instance.
    name: Browser Playwright
  - description: Read, write, and manage files on the browser instance.
    name: Browser Filesystem
  - description: Execute and manage processes on the browser instance.
    name: Browser Processes
  - description: Record and manage browser session video replays.
    name: Browser Replays
  - description: Stream logs from the browser instance.
    name: Browser Logs
  - description: >-
      Stream live telemetry events from a browser session, and manage the
      destinations sessions export them to.
    name: Browser Telemetry
  - description: Create, list, retrieve, and delete browser profiles.
    name: Profiles
  - description: Create and manage proxy configurations for routing browser traffic.
    name: Proxies
  - description: Create, list, retrieve, and delete browser extensions.
    name: Extensions
  - description: Create and manage browser pools for acquiring and releasing browsers.
    name: Browser Pools
  - description: Inspect the identity and authorization context for the current request.
    name: Authentication
  - description: >-
      Create and manage auth connections for automated credential capture and
      login.
    name: Managed Auth
  - description: Create and manage credentials for authentication.
    name: Credentials
  - description: Configure external credential providers like 1Password.
    name: Credential Providers
  - description: List applications and versions.
    name: Apps
  - description: Create and manage app deployments and stream deployment events.
    name: Deployments
  - description: Invoke actions and stream or query invocation status and events.
    name: Invocations
  - description: Read and manage organization-level limits.
    name: Organization
  - description: |
      Create and manage projects for resource isolation within an organization.
      When projects are disabled for the organization, project operations return
      `404` with code `projects_disabled`.
    name: Projects
  - description: Create and manage API keys for organization and project-scoped access.
    name: API Keys
  - description: Read audit log records for the authenticated organization.
    name: Audit Logs
  - description: Resolve browser and proxy recommendations for bot-protected sites.
    name: Site Configs
paths:
  /org/entitlements:
    get:
      tags:
        - Organization
      summary: Get organization entitlements
      description: >-
        Get the authenticated organization's effective feature access and
        constraints after applying its plan, active trial treatment, plan
        status, and organization-specific overrides. Null constraint values mean
        unlimited.
      operationId: getOrgEntitlements
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgEntitlements'
          description: Effective organization entitlements
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    OrgEntitlements:
      additionalProperties: false
      description: >-
        Effective feature access and constraints for the authenticated
        organization. Values already include trial treatment, plan status, and
        organization-specific overrides; consumers should use these resolved
        values instead of comparing plan IDs.
      properties:
        features:
          $ref: '#/components/schemas/OrgEntitlementFeatures'
        limits:
          $ref: '#/components/schemas/OrgEntitlementLimits'
        plan:
          $ref: '#/components/schemas/OrgEntitlementPlan'
      required:
        - plan
        - features
        - limits
      type: object
    OrgEntitlementFeatures:
      additionalProperties: false
      properties:
        browser_extensions:
          $ref: '#/components/schemas/OrgBrowserExtensionEntitlement'
        browser_pools:
          $ref: '#/components/schemas/OrgEntitlementFeature'
        browser_replays:
          $ref: '#/components/schemas/OrgBrowserReplayEntitlement'
        credential_providers:
          $ref: '#/components/schemas/OrgEntitlementFeature'
        credentials:
          $ref: '#/components/schemas/OrgEntitlementFeature'
        custom_proxies:
          $ref: '#/components/schemas/OrgEntitlementFeature'
        file_io:
          $ref: '#/components/schemas/OrgEntitlementFeature'
        gpu:
          $ref: '#/components/schemas/OrgEntitlementFeature'
        managed_auth:
          $ref: '#/components/schemas/OrgManagedAuthEntitlement'
        managed_proxies:
          $ref: '#/components/schemas/OrgEntitlementFeature'
        profiles:
          $ref: '#/components/schemas/OrgEntitlementFeature'
        proxy_bypass_hosts:
          $ref: '#/components/schemas/OrgEntitlementFeature'
      required:
        - profiles
        - file_io
        - browser_replays
        - browser_extensions
        - browser_pools
        - managed_auth
        - credentials
        - credential_providers
        - managed_proxies
        - custom_proxies
        - proxy_bypass_hosts
        - gpu
      type: object
    OrgEntitlementLimits:
      additionalProperties: false
      properties:
        default_max_concurrent_invocations_per_app:
          description: >-
            Effective org-level default concurrent invocation ceiling for apps
            without an app-specific override. App-specific overrides are not
            represented here.
          example: 20
          minimum: 1
          type: integer
        max_concurrent_browsers:
          description: >-
            Effective organization-wide ceiling shared by on-demand browsers and
            browser pool reservations.
          example: 150
          minimum: 1
          type: integer
        max_concurrent_invocations:
          description: Effective organization-wide concurrent app invocation ceiling.
          example: 50
          minimum: 1
          type: integer
      required:
        - max_concurrent_browsers
        - max_concurrent_invocations
        - default_max_concurrent_invocations_per_app
      type: object
    OrgEntitlementPlan:
      additionalProperties: false
      properties:
        effective_id:
          description: >-
            The plan used to resolve plan-based access. Active trials resolve to
            START_UP regardless of the contractual plan.
          enum:
            - FREE
            - HOBBYIST
            - START_UP
            - ENTERPRISE
          example: START_UP
          type: string
        id:
          description: >-
            The organization's contractual plan identifier. Use the resolved
            feature and limit values, not this field, for access decisions.
          enum:
            - FREE
            - HOBBYIST
            - START_UP
            - ENTERPRISE
          example: START_UP
          type: string
        is_trialing:
          description: Whether the organization is currently within its trial period.
          example: false
          type: boolean
        status:
          description: >-
            Current billing status of the contractual plan, or null when no
            billing status is recorded. Status-sensitive feature values already
            account for it.
          enum:
            - NEEDS_PAYMENT_METHOD
            - ACTIVE
            - CANCELED
            - UNPAID
          example: ACTIVE
          nullable: true
          type: string
        trial_ends_at:
          description: >-
            Configured trial end timestamp, or null when the organization has no
            trial. A past timestamp may be returned when is_trialing is false.
          example: null
          format: date-time
          nullable: true
          type: string
      required:
        - id
        - effective_id
        - status
        - is_trialing
        - trial_ends_at
      type: object
    Error:
      properties:
        code:
          description: Application-specific error code (machine-readable)
          example: bad_request
          type: string
        details:
          description: Additional error details (for multiple errors)
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
        inner_error:
          $ref: '#/components/schemas/ErrorDetail'
        message:
          description: Human-readable error description for debugging
          example: 'Missing required field: app_name'
          type: string
      required:
        - code
        - message
      type: object
    OrgBrowserExtensionEntitlement:
      additionalProperties: false
      properties:
        enabled:
          description: Whether browser extensions are available.
          example: true
          type: boolean
        max_stored_per_org:
          description: >-
            Maximum active custom extensions the organization may store. Null
            means unlimited. Loading stored extensions into a browser is not
            plan-limited.
          example: null
          minimum: 1
          nullable: true
          type: integer
      required:
        - enabled
        - max_stored_per_org
      type: object
    OrgEntitlementFeature:
      additionalProperties: false
      properties:
        enabled:
          description: Whether the organization is entitled to use this feature.
          example: true
          type: boolean
      required:
        - enabled
      type: object
    OrgBrowserReplayEntitlement:
      additionalProperties: false
      properties:
        enabled:
          description: Whether browser replay recording is available.
          example: true
          type: boolean
        retention_days:
          description: >-
            Number of days browser replays are retained, matching the replay
            reaper policy.
          example: 30
          minimum: 0
          type: integer
      required:
        - enabled
        - retention_days
      type: object
    OrgManagedAuthEntitlement:
      additionalProperties: false
      properties:
        enabled:
          description: Whether managed auth is available.
          example: true
          type: boolean
        health_check_interval_default_seconds:
          description: >-
            Effective interval in seconds used when a connection is created
            without an explicit health-check interval.
          example: 3600
          minimum: 1
          type: integer
        health_check_interval_max_seconds:
          description: Maximum accepted managed auth health-check interval in seconds.
          example: 86400
          minimum: 1
          type: integer
        health_check_interval_min_seconds:
          description: Minimum accepted managed auth health-check interval in seconds.
          example: 1200
          minimum: 1
          type: integer
        max_connections:
          description: >-
            Maximum active managed auth connections in the organization. Null
            means unlimited.
          example: null
          minimum: 1
          nullable: true
          type: integer
      required:
        - enabled
        - max_connections
        - health_check_interval_min_seconds
        - health_check_interval_default_seconds
        - health_check_interval_max_seconds
      type: object
    ErrorDetail:
      properties:
        code:
          description: Lower-level error code providing more specific detail
          example: invalid_input
          type: string
        message:
          description: Further detail about the error
          example: Provided version string is not semver compliant
          type: string
      type: object
  responses:
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Unauthorized – missing or invalid authorization token
    InternalError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Internal Server Error
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````