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

# Create a HarnessProfile

> Creates a workspace-scoped HarnessProfile under a logical `name` from one of four sources: `catalog` (adopt a ready HarnessCatalogEntry with its pinned image), `recipe` (a catalog entry name plus a digest-pinned image you supply), `oci` (an inline CreateHarnessRelease, creating release and profile together), or `release` (an existing HarnessRelease ID plus its exact driver version). Publishes version 1 of the profile and returns it with 201. Send `Idempotency-Key` to make retries safe; a missing catalog entry or release is a not-found error.

Checkfu support posture: alpha; hosted. Required evidence journey: harness-registry. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.



## OpenAPI

````yaml /openapi.json post /v1/harness-profiles
openapi: 3.1.0
info:
  title: Checkfu API
  version: '2026-08-27'
  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-27); 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: harnesses
  - name: harnessRuntime
  - name: computerProfiles
  - name: permissionAssignments
  - name: actionPolicies
  - name: files
  - name: memoryStores
  - name: dreams
  - name: modelCredentials
  - name: modelRoutingProfiles
  - name: blueprintInstallations
  - name: toolSources
  - name: skills
  - name: skillSources
  - name: agentSources
  - name: skillProposals
  - name: instructionProposals
  - name: catalog
  - name: concepts
  - name: support
  - name: connections
  - name: connectionVaults
  - name: connectionAssignments
  - name: connectedRuntimes
  - name: projects
  - name: collaboration
  - name: automationGraphs
  - name: automations
  - name: actionApprovals
  - name: standingApprovals
  - 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: sessionHandoffs
  - name: sessionCapsules
  - name: sessionTrajectories
  - name: webhookEndpoints
  - name: integrationGateway
  - name: agentDeployments
  - name: workEnvironments
  - name: computers
  - name: computerScreens
  - name: computerBrowserObservations
  - name: computerBrowserActions
  - name: environments
  - name: vaults
  - name: apiMcp
  - name: a2a
paths:
  /v1/harness-profiles:
    post:
      tags:
        - harnessRuntime
      summary: Create a HarnessProfile
      description: >-
        Creates a workspace-scoped HarnessProfile under a logical `name` from
        one of four sources: `catalog` (adopt a ready HarnessCatalogEntry with
        its pinned image), `recipe` (a catalog entry name plus a digest-pinned
        image you supply), `oci` (an inline CreateHarnessRelease, creating
        release and profile together), or `release` (an existing HarnessRelease
        ID plus its exact driver version). Publishes version 1 of the profile
        and returns it with 201. Send `Idempotency-Key` to make retries safe; a
        missing catalog entry or release is a not-found error.


        Checkfu support posture: alpha; hosted. Required evidence journey:
        harness-registry. Deployment-specific readiness and the latest proven
        release are available from GET /v1/support/capabilities.
      operationId: harnessRuntime.createHarnessProfile
      parameters:
        - name: checkfu-version
          in: header
          schema:
            type: string
            enum:
              - '2026-08-27'
          required: true
        - name: idempotency-key
          in: header
          schema:
            type: string
            allOf:
              - maxLength: 255
          required: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  allOf:
                    - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$
                source:
                  anyOf:
                    - type: object
                      properties:
                        kind:
                          type: string
                          enum:
                            - catalog
                        name:
                          type: string
                          allOf:
                            - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$
                        platform:
                          $ref: '#/components/schemas/Objects_8'
                      required:
                        - kind
                        - name
                      additionalProperties: false
                    - type: object
                      properties:
                        kind:
                          type: string
                          enum:
                            - recipe
                        name:
                          type: string
                          allOf:
                            - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$
                        image:
                          $ref: '#/components/schemas/OciImageReference'
                        platform:
                          $ref: '#/components/schemas/Objects_8'
                      required:
                        - kind
                        - name
                        - image
                      additionalProperties: false
                    - type: object
                      properties:
                        kind:
                          type: string
                          enum:
                            - oci
                        release:
                          $ref: '#/components/schemas/Union_47'
                      required:
                        - kind
                        - release
                      additionalProperties: false
                    - type: object
                      properties:
                        kind:
                          type: string
                          enum:
                            - release
                        release_id:
                          $ref: '#/components/schemas/HarnessReleaseId'
                        driver_version:
                          type: string
                          allOf:
                            - minLength: 1
                      required:
                        - kind
                        - release_id
                        - driver_version
                      additionalProperties: false
                configuration:
                  $ref: '#/components/schemas/HarnessConfiguration'
              required:
                - name
                - source
              additionalProperties: false
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    $ref: '#/components/schemas/HarnessProfileId'
                  workspace_id:
                    $ref: '#/components/schemas/WorkspaceId'
                  name:
                    type: string
                    allOf:
                      - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$
                  release_id:
                    $ref: '#/components/schemas/HarnessReleaseId'
                  driver_version:
                    type: string
                    allOf:
                      - minLength: 1
                  multiagent_shared_environment:
                    type: boolean
                  configuration:
                    $ref: '#/components/schemas/HarnessConfiguration'
                  version:
                    type: integer
                    allOf:
                      - exclusiveMinimum: 0
                  created_at:
                    type: string
                  updated_at:
                    type: string
                required:
                  - id
                  - workspace_id
                  - name
                  - release_id
                  - driver_version
                  - multiagent_shared_environment
                  - configuration
                  - version
                  - created_at
                  - updated_at
                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:
    Objects_8:
      type: object
      properties:
        os:
          type: string
          enum:
            - linux
        architecture:
          type: string
          enum:
            - amd64
            - arm64
      required:
        - os
        - architecture
      additionalProperties: false
    OciImageReference:
      type: string
    Union_47:
      anyOf:
        - type: object
          properties:
            image:
              $ref: '#/components/schemas/OciImageReference'
            entrypoint:
              type: string
              allOf:
                - maxLength: 4096
                - pattern: >-
                    ^\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+(?:\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+)*$
            working_directory:
              type: string
              allOf:
                - maxLength: 4096
                - pattern: >-
                    ^\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+(?:\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+)*$
            platform:
              type: object
              properties:
                os:
                  type: string
                  enum:
                    - linux
                architecture:
                  type: string
                  enum:
                    - amd64
                    - arm64
              required:
                - os
                - architecture
              additionalProperties: false
            configuration_schema:
              $ref: '#/components/schemas/Union_38'
            model_wire_dialects:
              type: array
              items:
                type: string
                enum:
                  - anthropic_messages
                  - openai_chat
                  - openai_responses
                  - fal_queue
              allOf:
                - minItems: 1
                - maxItems: 4
                - uniqueItems: true
            argv: false
            prompt_transport: false
            output_mode: false
            resume_flag: false
            output_schema_flag: false
            output_schema_transport: false
            managed_adapter_release: false
            protocol:
              type: string
              enum:
                - acp-v1
            arguments:
              $ref: '#/components/schemas/HarnessProcessArgumentVectorUtf8Bytes'
            mcp_delivery:
              type: string
              enum:
                - session_http
                - none
          required:
            - image
            - entrypoint
          additionalProperties: false
        - $ref: '#/components/schemas/CreateOneShotHarnessReleaseContract'
    HarnessReleaseId:
      type: string
      allOf:
        - pattern: ^hrel_[0-9a-f]{32}$
    HarnessConfiguration:
      type: object
      additionalProperties:
        description: >-
          A value in the JSON data model: null, boolean, finite number, string,
          array, or object.
        allOf:
          - x-checkfu-json-budget:
              maximumBytes: 65536
              maximumDepth: 32
              maximumNodes: 4000
              maximumInspectionWork: 4000
      allOf:
        - x-checkfu-json-budget:
            maximumBytes: 65536
            maximumDepth: 32
            maximumNodes: 4000
            maximumInspectionWork: 4000
        - maxProperties: 4000
          description: harness configuration of at most 64 KiB, depth 32, and 4,000 nodes
    HarnessProfileId:
      type: string
      allOf:
        - pattern: ^hprof_[0-9a-f]{32}$
    WorkspaceId:
      type: string
      allOf:
        - 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.
    Union_38:
      anyOf:
        - type: boolean
        - $ref: '#/components/schemas/HarnessConfigurationSchemaObject'
    HarnessProcessArgumentVectorUtf8Bytes:
      type: array
      items:
        $ref: '#/components/schemas/HarnessProcessArgumentUtf8Bytes'
      allOf:
        - maxItems: 256
          description: >-
            At most 256 exact process arguments and 131072 aggregate UTF-8 bytes
            including one terminator per argument
    CreateOneShotHarnessReleaseContract:
      type: object
      properties:
        image:
          $ref: '#/components/schemas/OciImageReference'
        entrypoint:
          type: string
          allOf:
            - maxLength: 4096
            - pattern: >-
                ^\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+(?:\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+)*$
        working_directory:
          type: string
          allOf:
            - maxLength: 4096
            - pattern: >-
                ^\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+(?:\/(?!\.{1,2}(?:\/|$))[A-Za-z0-9._-]+)*$
        platform:
          type: object
          properties:
            os:
              type: string
              enum:
                - linux
            architecture:
              type: string
              enum:
                - amd64
                - arm64
          required:
            - os
            - architecture
          additionalProperties: false
        configuration_schema:
          $ref: '#/components/schemas/Union_38'
        model_wire_dialects:
          type: array
          items:
            type: string
            enum:
              - anthropic_messages
              - openai_chat
              - openai_responses
              - fal_queue
          allOf:
            - minItems: 1
            - maxItems: 4
            - uniqueItems: true
        protocol:
          type: string
          enum:
            - oneshot-v1
        arguments: false
        mcp_delivery: false
        argv:
          $ref: '#/components/schemas/OneShotArgvPlaceholders'
        prompt_transport:
          $ref: '#/components/schemas/Union_43'
        output_mode:
          $ref: '#/components/schemas/Union_44'
        resume_flag:
          type: string
          allOf:
            - maxLength: 65536
            - pattern: ^[^\u0000]*$
              description: >-
                Exact process argument text, preserving whitespace; U+0000 is
                forbidden and UTF-8 encoding is limited to 65536 bytes
            - minLength: 1
        output_schema_flag:
          type: string
          allOf:
            - maxLength: 65536
            - pattern: ^[^\u0000]*$
              description: >-
                Exact process argument text, preserving whitespace; U+0000 is
                forbidden and UTF-8 encoding is limited to 65536 bytes
            - minLength: 1
        output_schema_transport:
          type: string
          enum:
            - argv_json
            - argv_path
      required:
        - image
        - entrypoint
        - protocol
        - argv
        - prompt_transport
        - output_mode
      additionalProperties: false
    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.
    HarnessConfigurationSchemaObject:
      type: object
      additionalProperties:
        description: >-
          A value in the JSON data model: null, boolean, finite number, string,
          array, or object.
        allOf:
          - x-checkfu-json-budget:
              maximumBytes: 65536
              maximumDepth: 32
              maximumNodes: 4000
              maximumInspectionWork: 4000
      allOf:
        - x-checkfu-json-budget:
            maximumBytes: 65536
            maximumDepth: 32
            maximumNodes: 4000
            maximumInspectionWork: 4000
        - maxProperties: 4000
          description: >-
            harness configuration schema of at most 64 KiB, depth 32, and 4,000
            nodes
    HarnessProcessArgumentUtf8Bytes:
      type: string
      allOf:
        - maxLength: 65536
        - pattern: ^[^\u0000]*$
          description: >-
            Exact process argument text, preserving whitespace; U+0000 is
            forbidden and UTF-8 encoding is limited to 65536 bytes
    OneShotArgvPlaceholders:
      type: array
      items:
        $ref: '#/components/schemas/HarnessProcessArgumentUtf8Bytes'
      allOf:
        - maxItems: 256
          description: >-
            At most 256 exact process arguments and 131072 aggregate UTF-8 bytes
            including one terminator per argument
    Union_43:
      type: string
      enum:
        - stdin
        - argv_path
    Union_44:
      type: string
      enum:
        - stream_json
        - text
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````