> ## Documentation Index
> Fetch the complete documentation index at: https://docs.checkfu.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Enroll a ConnectedRuntime for an Agent

> Enrolls an operator-controlled, already-running harness in one call: name the Agent and optional version policy, and the control plane creates the…



## OpenAPI

````yaml /openapi.json post /v1/connected-runtime-enrollments
openapi: 3.1.0
info:
  title: Checkfu API
  version: '2026-08-31'
  description: >-
    Authentication is declared per operation: API-key, runtime, or connector
    bearer; Automation signature; or credential-free pairing redemption. Every
    general Checkfu REST request requires the dated `Checkfu-Version` header
    (one of: 2026-08-31); the three MCP JSON-RPC transports use
    `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth
    callback carries neither Checkfu header. API keys resolve one Workspace
    without a request selector; authenticated responses identify it with
    `Checkfu-Workspace-Id`.
servers:
  - url: https://api.checkfu.com
security:
  - bearerAuth: []
tags:
  - name: organizations
  - name: sourceRepositories
  - name: tenants
  - name: workspaces
  - name: principals
  - name: principalGroups
  - name: principalAccessCredentials
  - name: apiKeys
  - name: agents
  - name: harnessRuntime
  - name: permissionAssignments
  - name: actionPolicies
  - name: files
  - name: memoryStores
  - name: modelCredentials
  - name: modelRoutingProfiles
  - name: toolSources
  - name: skills
  - name: skillSources
  - name: agentBlueprints
  - name: skillProposals
  - name: instructionProposals
  - name: catalog
  - name: managedTools
  - name: concepts
  - name: support
  - name: connections
  - name: connectionVaults
  - name: connectionAssignments
  - name: connectedRuntimes
  - name: fileTrees
  - name: collaboration
  - name: automationGraphs
  - name: automations
  - name: actionApprovals
  - name: standingApprovals
  - name: workloadReviewPolicies
  - name: usage
  - name: models
  - name: outcomes
  - name: budgets
  - name: billing
  - name: sessions
  - name: audit
  - name: sessionExports
  - name: runs
  - name: runnerPools
  - name: transcripts
  - name: sessionWatches
  - name: sessionCapsules
  - name: sessionTrajectories
  - name: webhookEndpoints
  - name: integrationGateway
  - name: workEnvironments
  - name: computers
  - name: computerScreens
  - name: computerBrowserObservations
  - name: computerBrowserActions
  - name: environments
  - name: computerHeadlessOperations
  - name: vaults
  - name: apiMcp
  - name: a2a
paths:
  /v1/connected-runtime-enrollments:
    post:
      tags:
        - connectedRuntimes
      summary: Enroll a ConnectedRuntime for an Agent
      description: >-
        Enrolls an operator-controlled, already-running harness in one call:
        name the Agent and optional version policy, and the control plane
        creates the private attachment graph — ExternalInstallation,
        CollaborationSpace, AgentPlacement, and service Principal — alongside
        the ConnectedRuntime. Returns that whole graph plus the write-only
        connector bearer exactly once, with 201. Enrollment first freezes a
        non-secret intent containing the selected immutable AgentVersion
        semantics, so a retry under the same required `Idempotency-Key` recovers
        the same enrollment and a mutable draft edit cannot change it. Register
        an optional Ed25519 `attestation_key` here to have signed observation
        batches graded `attested`.


        Checkfu support posture: alpha; hosted. Required evidence journey:
        connected-runtime. Deployment-specific readiness and the latest proven
        release are available from GET /v1/support/capabilities.
      operationId: connectedRuntimes.enrollConnectedRuntime
      parameters:
        - name: checkfu-version
          in: header
          schema:
            type: string
            enum:
              - '2026-08-31'
          required: true
        - name: idempotency-key
          in: header
          schema:
            type: string
            allOf:
              - maxLength: 255
              - minLength: 1
          required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$
                agent:
                  $ref: '#/components/schemas/ConnectedRuntimeAgentSelector'
                environment_id:
                  $ref: '#/components/schemas/EnvironmentId'
                attestation_key:
                  type: object
                  properties:
                    algorithm:
                      type: string
                      enum:
                        - Ed25519
                    public_key:
                      type: string
                      pattern: ^[A-Za-z0-9_-]{43}$
                  required:
                    - algorithm
                    - public_key
                  additionalProperties: false
              required:
                - name
                - agent
                - environment_id
              additionalProperties: false
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  runtime:
                    $ref: '#/components/schemas/Objects_90'
                  token:
                    type: string
                    allOf:
                      - pattern: >-
                          ^cfu_connector_wrkspc_[0-9a-f]{32}\.crt_[0-9a-f]{32}\.[A-Za-z0-9_-]{43}$
                      - maxLength: 180
                  external_installation:
                    $ref: '#/components/schemas/Objects_91'
                  collaboration_space:
                    $ref: '#/components/schemas/Union_184'
                  agent_placement:
                    $ref: '#/components/schemas/Objects_96'
                  service_principal:
                    $ref: '#/components/schemas/Principal_1'
                required:
                  - runtime
                  - token
                  - external_installation
                  - collaboration_space
                  - agent_placement
                  - service_principal
                additionalProperties: false
          headers:
            checkfu-workspace-id:
              description: The Workspace resolved from the authenticated bearer credential.
              required: true
              schema:
                $ref: '#/components/schemas/WorkspaceId'
        '400':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - validation.malformed
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#validation-malformed
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    required:
                      - type
                      - message
                      - more
                    additionalProperties: false
                additionalProperties: false
        '401':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - auth.invalid_key
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#auth-invalid-key
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '403':
          description: >-
            The organization, tenant, or workspace backing this key is
            administratively disabled. | Deployment governance or retention
            policy denied the request.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - auth.disabled_tenancy
                          message:
                            type: string
                          more:
                            type: string
                            enum:
                              - >-
                                https://docs.checkfu.com/reference/errors#auth-disabled-tenancy
                            description: >-
                              Stable public documentation and remedy for this
                              error type.
                        required:
                          - type
                          - message
                          - more
                        additionalProperties: false
                    additionalProperties: false
                  - $ref: '#/components/schemas/PolicyDeniedError'
        '404':
          description: >-
            The requested resource does not exist in the resolved deployment
            boundary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationNotFoundError'
        '409':
          description: >-
            The request conflicts with the resource's current state. | An
            idempotent mutation conflicts with a completed or in-progress
            request for the same key.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ValidationConflictError'
                  - $ref: '#/components/schemas/IdempotencyConflictError'
        '429':
          description: Typed Checkfu wire error
          headers:
            retry-after:
              description: >-
                Delay in seconds for rate limits or deployment quotas with a
                known release or UTC reset boundary
              required: false
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - budget.exceeded
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#budget-exceeded
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '500':
          description: >-
            An unexpected internal failure occurred; the message contains an
            opaque incident reference.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeInternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    ConnectedRuntimeAgentSelector:
      anyOf:
        - $ref: '#/components/schemas/AgentId'
        - $ref: '#/components/schemas/ManagedAgentsAgentParams'
    EnvironmentId:
      type: string
      pattern: ^env_[0-9a-f]{32}$
    Objects_90:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ConnectedRuntimeId'
        workspace_id:
          $ref: '#/components/schemas/WorkspaceId'
        name:
          type: string
          pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$
        harness:
          type: string
          pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$
        protocol:
          type: string
          enum:
            - acp-v1
        agent_placement_id:
          $ref: '#/components/schemas/AgentPlacementId'
        collaboration_space_id:
          $ref: '#/components/schemas/CollaborationSpaceId'
        owner_principal_id:
          anyOf:
            - $ref: '#/components/schemas/PrincipalId'
            - type: 'null'
        attestation_key:
          anyOf:
            - type: object
              properties:
                algorithm:
                  type: string
                  enum:
                    - Ed25519
                version:
                  type: integer
                  exclusiveMinimum: 0
                public_key:
                  type: string
                  pattern: ^[A-Za-z0-9_-]{43}$
              required:
                - algorithm
                - version
                - public_key
              additionalProperties: false
            - type: 'null'
        state:
          type: string
          enum:
            - active
            - revoked
        version:
          type: integer
          exclusiveMinimum: 0
        created_at:
          type: string
        updated_at:
          type: string
        revoked_at:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - id
        - workspace_id
        - name
        - harness
        - protocol
        - agent_placement_id
        - collaboration_space_id
        - owner_principal_id
        - state
        - version
        - created_at
        - updated_at
        - revoked_at
      additionalProperties: false
    Objects_91:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/CollaborationInstallationId'
        workspace_id:
          $ref: '#/components/schemas/WorkspaceId'
        provider:
          type: string
          pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$
        external_tenant_id:
          type: string
          allOf:
            - minLength: 1
            - maxLength: 512
        display_name:
          $ref: '#/components/schemas/Union_182'
        state:
          $ref: '#/components/schemas/Union_183'
        version:
          type: integer
          exclusiveMinimum: 0
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - workspace_id
        - provider
        - external_tenant_id
        - display_name
        - state
        - version
        - created_at
        - updated_at
      additionalProperties: false
    Union_184:
      anyOf:
        - $ref: '#/components/schemas/Objects_92'
        - $ref: '#/components/schemas/Objects_95'
    Objects_96:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/AgentPlacementId'
        workspace_id:
          $ref: '#/components/schemas/WorkspaceId'
        external_installation_id:
          $ref: '#/components/schemas/CollaborationInstallationId'
        agent:
          $ref: '#/components/schemas/ManagedAgentsAgentParams'
        acted_as:
          $ref: '#/components/schemas/PrincipalId'
        identity_posture:
          $ref: '#/components/schemas/Union_195'
        collaboration_space_ids:
          $ref: '#/components/schemas/Arrays_31'
        environment_id:
          $ref: '#/components/schemas/EnvironmentId'
        harness:
          type: string
          pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})(?:@(?:latest|[1-9][0-9]{0,8}))?$
        state:
          $ref: '#/components/schemas/Union_196'
        version:
          type: integer
          exclusiveMinimum: 0
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - workspace_id
        - external_installation_id
        - agent
        - acted_as
        - identity_posture
        - collaboration_space_ids
        - environment_id
        - harness
        - state
        - version
        - created_at
        - updated_at
      additionalProperties: false
    Principal_1:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/PrincipalId'
        workspace_id:
          $ref: '#/components/schemas/WorkspaceId'
        external_subject_id:
          type: string
          allOf:
            - minLength: 1
        principal_type:
          $ref: '#/components/schemas/Union_13'
        display_name:
          anyOf:
            - type: string
              allOf:
                - minLength: 1
                - maxLength: 255
            - type: 'null'
        attributes:
          $ref: '#/components/schemas/PrincipalAttributes'
        status:
          $ref: '#/components/schemas/Union_3'
        resource_version:
          type: integer
          allOf:
            - exclusiveMinimum: 0
            - maximum: 9007199254740991
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - workspace_id
        - external_subject_id
        - principal_type
        - display_name
        - attributes
        - status
        - resource_version
        - created_at
        - updated_at
      additionalProperties: false
      description: One Workspace Principal and its public identity attributes.
    WorkspaceId:
      type: string
      pattern: ^wrkspc_[0-9a-f]{32}$
    PolicyDeniedError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - policy.denied
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#policy-denied
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: Deployment governance or retention policy denied the request.
    ValidationNotFoundError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.not_found
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-not-found
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        The requested resource does not exist in the resolved deployment
        boundary.
    ValidationConflictError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.conflict
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-conflict
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: The request conflicts with the resource's current state.
    IdempotencyConflictError:
      anyOf:
        - $ref: '#/components/schemas/ValidationIdempotencyConflictError'
        - $ref: '#/components/schemas/ValidationIdempotencyInProgressError'
      description: >-
        An idempotent mutation conflicts with a completed or in-progress request
        for the same key.
    RuntimeInternalError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - runtime.internal
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#runtime-internal
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        An unexpected internal failure occurred; the message contains an opaque
        incident reference.
    AgentId:
      type: string
      pattern: ^agent_[0-9a-f]{32}$
    ManagedAgentsAgentParams:
      type: object
      properties:
        type:
          type: string
          enum:
            - agent
        id:
          $ref: '#/components/schemas/AgentId'
        version:
          type: integer
          exclusiveMinimum: 0
      required:
        - type
        - id
      additionalProperties: false
    ConnectedRuntimeId:
      type: string
      pattern: ^crt_[0-9a-f]{32}$
    AgentPlacementId:
      type: string
      pattern: ^aplace_[0-9a-f]{32}$
    CollaborationSpaceId:
      type: string
      pattern: ^cspace_[0-9a-f]{32}$
    PrincipalId:
      type: string
      pattern: ^prin_[0-9a-f]{32}$
    CollaborationInstallationId:
      type: string
      pattern: ^exti_[0-9a-f]{32}$
    Union_182:
      anyOf:
        - type: string
          allOf:
            - minLength: 1
            - maxLength: 512
            - maxLength: 255
        - type: 'null'
    Union_183:
      type: string
      enum:
        - active
        - disabled
        - disconnected
        - uninstalled
    Objects_92:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/CollaborationSpaceId'
        workspace_id:
          $ref: '#/components/schemas/WorkspaceId'
        external_installation_id:
          $ref: '#/components/schemas/CollaborationInstallationId'
        external_id:
          type: string
          allOf:
            - minLength: 1
            - maxLength: 512
        visibility:
          $ref: '#/components/schemas/Union_185'
        membership:
          $ref: '#/components/schemas/Union_186'
        inheritance:
          $ref: '#/components/schemas/Union_187'
        display_name:
          anyOf:
            - type: string
              allOf:
                - minLength: 1
                - maxLength: 512
                - maxLength: 255
            - type: 'null'
        state:
          $ref: '#/components/schemas/Union_188'
        verified_member:
          $ref: '#/components/schemas/Union_189'
        membership_assertion:
          $ref: '#/components/schemas/Union_190'
        ambient_policy:
          $ref: '#/components/schemas/Union_191'
        version:
          type: integer
          exclusiveMinimum: 0
        created_at:
          type: string
        updated_at:
          type: string
        kind:
          type: string
          enum:
            - root
        parent_id:
          type: 'null'
      required:
        - id
        - workspace_id
        - external_installation_id
        - external_id
        - visibility
        - membership
        - inheritance
        - display_name
        - state
        - verified_member
        - membership_assertion
        - ambient_policy
        - version
        - created_at
        - updated_at
        - kind
        - parent_id
      additionalProperties: false
    Objects_95:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/CollaborationSpaceId'
        workspace_id:
          $ref: '#/components/schemas/WorkspaceId'
        external_installation_id:
          $ref: '#/components/schemas/CollaborationInstallationId'
        external_id:
          type: string
          allOf:
            - minLength: 1
            - maxLength: 512
        visibility:
          $ref: '#/components/schemas/Union_185'
        membership:
          $ref: '#/components/schemas/Union_186'
        inheritance:
          $ref: '#/components/schemas/Union_187'
        display_name:
          anyOf:
            - type: string
              allOf:
                - minLength: 1
                - maxLength: 512
                - maxLength: 255
            - type: 'null'
        state:
          $ref: '#/components/schemas/Union_188'
        verified_member:
          $ref: '#/components/schemas/Union_189'
        membership_assertion:
          $ref: '#/components/schemas/Union_190'
        ambient_policy:
          $ref: '#/components/schemas/Union_191'
        version:
          type: integer
          exclusiveMinimum: 0
        created_at:
          type: string
        updated_at:
          type: string
        kind:
          type: string
          enum:
            - team
            - channel
            - personal
        parent_id:
          $ref: '#/components/schemas/CollaborationSpaceId'
      required:
        - id
        - workspace_id
        - external_installation_id
        - external_id
        - visibility
        - membership
        - inheritance
        - display_name
        - state
        - verified_member
        - membership_assertion
        - ambient_policy
        - version
        - created_at
        - updated_at
        - kind
        - parent_id
      additionalProperties: false
    Union_195:
      type: string
      enum:
        - delegated
        - autonomous
    Arrays_31:
      type: array
      items:
        $ref: '#/components/schemas/CollaborationSpaceId'
      allOf:
        - minItems: 1
        - maxItems: 1000
    Union_196:
      type: string
      enum:
        - active
        - disabled
        - archived
    Union_13:
      type: string
      enum:
        - person
        - service
    PrincipalAttributes:
      type: object
      additionalProperties:
        type: string
      allOf:
        - propertyNames:
            type: string
            allOf:
              - minLength: 1
    Union_3:
      type: string
      enum:
        - active
        - disabled
    ValidationIdempotencyConflictError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.idempotency_conflict
            message:
              type: string
            more:
              type: string
              enum:
                - >-
                  https://docs.checkfu.com/reference/errors#validation-idempotency-conflict
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: The Idempotency-Key is already bound to a different request.
    ValidationIdempotencyInProgressError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.idempotency_in_progress
            message:
              type: string
            more:
              type: string
              enum:
                - >-
                  https://docs.checkfu.com/reference/errors#validation-idempotency-in-progress
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        An identical idempotent request is still in progress and may be retried
        later.
    Union_185:
      type: string
      enum:
        - public
        - private
        - personal
    Union_186:
      type: string
      enum:
        - public
        - provider_members
        - personal
    Union_187:
      type: string
      enum:
        - inherit
        - isolate
    Union_188:
      type: string
      enum:
        - active
        - disabled
        - disconnected
        - archived
    Union_189:
      anyOf:
        - type: object
          properties:
            principal_id:
              $ref: '#/components/schemas/PrincipalId'
            external_identity_link_id:
              $ref: '#/components/schemas/ExternalIdentityLinkId'
            paired_at:
              type: string
          required:
            - principal_id
            - external_identity_link_id
            - paired_at
          additionalProperties: false
        - type: 'null'
    Union_190:
      anyOf:
        - type: object
          properties:
            asserted_at:
              type: string
            freshness_horizon_seconds:
              type: integer
              allOf:
                - minimum: 60
                - maximum: 86400
          required:
            - asserted_at
            - freshness_horizon_seconds
          additionalProperties: false
        - type: 'null'
    Union_191:
      anyOf:
        - type: object
          properties:
            enabled:
              type: boolean
            muted:
              type: boolean
            max_responses_per_window:
              type: integer
              minimum: 0
            max_tokens_per_window:
              type: integer
              minimum: 0
            self_quiet_threshold:
              type: integer
              minimum: 0
            check:
              type: object
              properties:
                evaluation:
                  $ref: '#/components/schemas/Objects_93'
                rule:
                  $ref: '#/components/schemas/Union_194'
              required:
                - evaluation
                - rule
              additionalProperties: false
            context:
              type: object
              properties:
                mode:
                  type: string
                  enum:
                    - current_message
                    - thread
                require_history:
                  type: boolean
                agent_remit:
                  type: string
                  allOf:
                    - minLength: 1
                    - maxLength: 1024
              required:
                - mode
              additionalProperties: false
          required:
            - enabled
            - muted
            - max_responses_per_window
            - max_tokens_per_window
            - self_quiet_threshold
          additionalProperties: false
        - type: 'null'
    ExternalIdentityLinkId:
      type: string
      pattern: ^xid_[0-9a-f]{32}$
    Objects_93:
      type: object
      properties:
        schema_version:
          type: number
          enum:
            - 1
        model_routing_profile_key:
          type: string
          pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$
        tier:
          $ref: '#/components/schemas/Union_132'
        timeout_ms:
          type: number
          allOf:
            - minimum: 100
            - maximum: 30000
        questions:
          $ref: '#/components/schemas/TypedCheckQuestions'
      required:
        - schema_version
        - model_routing_profile_key
        - questions
      additionalProperties: false
    Union_194:
      anyOf:
        - $ref: '#/components/schemas/CheckBooleanRuleThresholds'
        - $ref: '#/components/schemas/Objects_94'
        - $ref: '#/components/schemas/CheckScoreTailRuleThresholds'
        - type: object
          properties:
            type:
              type: string
              enum:
                - all
            rules:
              type: array
              items:
                anyOf:
                  - $ref: '#/components/schemas/CheckBooleanRuleThresholds'
                  - $ref: '#/components/schemas/Objects_94'
                  - $ref: '#/components/schemas/CheckScoreTailRuleThresholds'
              allOf:
                - minItems: 1
                - maxItems: 8
          required:
            - type
            - rules
          additionalProperties: false
    Union_132:
      type: string
      enum:
        - default
        - planning
        - tool_loop
    TypedCheckQuestions:
      type: array
      items:
        anyOf:
          - type: object
            properties:
              key:
                $ref: '#/components/schemas/CheckQuestionKey'
              type:
                type: string
                enum:
                  - boolean
              instructions:
                type: string
                allOf:
                  - minLength: 1
                  - maxLength: 4096
              true_description:
                $ref: '#/components/schemas/CheckDescription'
              false_description:
                $ref: '#/components/schemas/CheckDescription'
            required:
              - key
              - type
              - instructions
            additionalProperties: false
          - type: object
            properties:
              key:
                $ref: '#/components/schemas/CheckQuestionKey'
              type:
                type: string
                enum:
                  - choice
              instructions:
                type: string
                allOf:
                  - minLength: 1
                  - maxLength: 4096
              options:
                $ref: '#/components/schemas/CheckChoiceOptions'
            required:
              - key
              - type
              - instructions
              - options
            additionalProperties: false
          - type: object
            properties:
              key:
                $ref: '#/components/schemas/CheckQuestionKey'
              type:
                type: string
                enum:
                  - score
              instructions:
                type: string
                allOf:
                  - minLength: 1
                  - maxLength: 4096
              levels:
                $ref: '#/components/schemas/CheckScoreLevels'
            required:
              - key
              - type
              - instructions
              - levels
            additionalProperties: false
      allOf:
        - minItems: 1
        - maxItems: 8
    CheckBooleanRuleThresholds:
      type: object
      properties:
        type:
          type: string
          enum:
            - boolean
        question_key:
          $ref: '#/components/schemas/CheckQuestionKey'
        expected:
          type: boolean
        false_max:
          type: number
          allOf:
            - minimum: 0
            - maximum: 1
        true_min:
          type: number
          allOf:
            - minimum: 0
            - maximum: 1
      required:
        - type
        - question_key
        - expected
        - false_max
        - true_min
      additionalProperties: false
    Objects_94:
      type: object
      properties:
        type:
          type: string
          enum:
            - choice_matches
        question_key:
          $ref: '#/components/schemas/CheckQuestionKey'
        option_keys:
          $ref: '#/components/schemas/CheckChoiceMatchesOptions'
        min_probability:
          type: number
          allOf:
            - minimum: 0
            - maximum: 1
        min_margin:
          type: number
          allOf:
            - minimum: 0
            - maximum: 1
      required:
        - type
        - question_key
        - option_keys
        - min_probability
        - min_margin
      additionalProperties: false
    CheckScoreTailRuleThresholds:
      type: object
      properties:
        type:
          type: string
          enum:
            - score_tail
        question_key:
          $ref: '#/components/schemas/CheckQuestionKey'
        at_or_above_level:
          type: integer
          minimum: 0
        false_max:
          type: number
          allOf:
            - minimum: 0
            - maximum: 1
        true_min:
          type: number
          allOf:
            - minimum: 0
            - maximum: 1
      required:
        - type
        - question_key
        - at_or_above_level
        - false_max
        - true_min
      additionalProperties: false
    CheckQuestionKey:
      type: string
      allOf:
        - minLength: 1
        - maxLength: 64
    CheckDescription:
      type: string
      allOf:
        - minLength: 1
    CheckChoiceOptions:
      type: array
      items:
        type: object
        properties:
          key:
            $ref: '#/components/schemas/CheckQuestionKey'
          description:
            $ref: '#/components/schemas/CheckDescription'
        required:
          - key
          - description
        additionalProperties: false
      allOf:
        - minItems: 2
        - maxItems: 32
    CheckScoreLevels:
      type: array
      items:
        $ref: '#/components/schemas/CheckDescription'
      allOf:
        - minItems: 2
        - maxItems: 10
    CheckChoiceMatchesOptions:
      type: array
      items:
        $ref: '#/components/schemas/CheckQuestionKey'
      allOf:
        - minItems: 1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.