> ## 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. # 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… ## OpenAPI ````yaml /openapi.json post /v1/harness-profiles 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/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-31' 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 pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ source: anyOf: - type: object properties: kind: type: string enum: - catalog name: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ platform: $ref: '#/components/schemas/Objects_7' required: - kind - name additionalProperties: false - type: object properties: kind: type: string enum: - recipe name: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ image: $ref: '#/components/schemas/OciImageReference' platform: $ref: '#/components/schemas/Objects_7' required: - kind - name - image additionalProperties: false - type: object properties: kind: type: string enum: - oci release: $ref: '#/components/schemas/Union_51' 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 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 catalog_capability_ceiling: $ref: '#/components/schemas/Objects_17' configuration: $ref: '#/components/schemas/HarnessConfiguration' version: type: integer 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_7: type: object properties: os: type: string enum: - linux architecture: type: string enum: - amd64 - arm64 required: - os - architecture additionalProperties: false OciImageReference: type: string Union_51: 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_42' model_wire_dialects: $ref: '#/components/schemas/Arrays_12' 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/HarnessContainerContract' - $ref: '#/components/schemas/CreateOneShotHarnessReleaseContract' HarnessReleaseId: type: string 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 x-checkfu-unicode-scalar-values: true allOf: - x-checkfu-json-budget: maximumBytes: 65536 maximumDepth: 32 maximumNodes: 4000 maximumInspectionWork: 4000 x-checkfu-unicode-scalar-values: true - maxProperties: 4000 description: harness configuration of at most 64 KiB, depth 32, and 4,000 nodes HarnessProfileId: type: string pattern: ^hprof_[0-9a-f]{32}$ WorkspaceId: type: string pattern: ^wrkspc_[0-9a-f]{32}$ Objects_17: type: object properties: event_fidelity: type: string enum: - native - structured - text_only - minimal continuation: type: string enum: - in_flight - next_turn - rebuild_only checkpoint: type: string enum: - process_and_disk - disk_only - conversation_only - none approval_delivery: type: string enum: - park - snapshot_release - end_reinject - unsupported interrupt: type: string enum: - cooperative - kill_only mid_run_input: type: string enum: - native - turn_boundary_only - unsupported model_control: type: string enum: - platform_enforced - compatible - opaque - harness_owned usage_authority: type: string enum: - platform_observed - harness_reported - unknown multiagent_shared_environment: type: boolean subagents: type: string enum: - observed - flatten required: - event_fidelity - continuation - checkpoint - approval_delivery - interrupt - mid_run_input - model_control - usage_authority - multiagent_shared_environment additionalProperties: false 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_42: anyOf: - type: boolean - $ref: '#/components/schemas/HarnessConfigurationSchemaObject' Arrays_12: type: array items: type: string enum: - anthropic_messages - openai_chat - openai_responses - fal_queue allOf: - minItems: 1 - maxItems: 4 - uniqueItems: true 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 HarnessContainerContract: 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_42' model_wire_dialects: $ref: '#/components/schemas/Arrays_12' argv: false prompt_transport: false output_mode: false resume_flag: false output_schema_flag: false output_schema_transport: false protocol: type: string enum: - container-v2 arguments: $ref: '#/components/schemas/HarnessProcessArgumentVectorUtf8Bytes' mcp_delivery: type: string enum: - session_http - none container_adapter: $ref: '#/components/schemas/Objects_22' requirements: $ref: '#/components/schemas/Objects_23' capability_claims: $ref: '#/components/schemas/Objects_24' managed_adapter_release: false required: - image - entrypoint - model_wire_dialects - protocol - arguments - container_adapter - requirements - capability_claims additionalProperties: false 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_42' model_wire_dialects: $ref: '#/components/schemas/Arrays_12' protocol: type: string enum: - oneshot-v1 arguments: false mcp_delivery: false argv: $ref: '#/components/schemas/OneShotArgvPlaceholders' prompt_transport: $ref: '#/components/schemas/Union_47' output_mode: $ref: '#/components/schemas/Union_48' 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 x-checkfu-unicode-scalar-values: true allOf: - x-checkfu-json-budget: maximumBytes: 65536 maximumDepth: 32 maximumNodes: 4000 maximumInspectionWork: 4000 x-checkfu-unicode-scalar-values: true - 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 Objects_22: type: object properties: abi_revision: type: number enum: - 2 cohort_digest: type: string pattern: ^sha256:[0-9a-f]{64}$ module: type: object properties: package_name: type: string allOf: - maxLength: 214 - pattern: ^(?:@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9._-]*$ package_version: type: string pattern: >- ^(?:0|[1-9][0-9]*)\.(?:0|[1-9][0-9]*)\.(?:0|[1-9][0-9]*)(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$ export_subpath: type: string allOf: - maxLength: 256 - pattern: ^(?:\.|\.\/[a-z0-9][a-z0-9._-]*(?:\/[a-z0-9][a-z0-9._-]*)*)$ export_name: type: string pattern: ^[A-Za-z_$][A-Za-z0-9_$]{0,127}$ source_digest: type: string pattern: ^sha256:[0-9a-f]{64}$ required: - package_name - package_version - export_subpath - export_name - source_digest additionalProperties: false native_interface: anyOf: - type: object properties: kind: type: string enum: - acp protocol_revision: type: number enum: - 1 client_package: type: string enum: - '@agentclientprotocol/sdk' client_version: type: string enum: - 1.7.0 required: - kind - protocol_revision - client_package - client_version additionalProperties: false - type: object properties: kind: type: string enum: - deepseek-native implementation_package: type: string enum: - '@deepseek-ai/dsh-app-boot' implementation_version: type: string enum: - 0.2.1-alpha.2 required: - kind - implementation_package - implementation_version additionalProperties: false - type: object properties: kind: type: string enum: - pi-coding implementation_package: type: string enum: - '@earendil-works/pi-coding-agent' implementation_version: type: string enum: - 1.1.0 required: - kind - implementation_package - implementation_version additionalProperties: false - type: object properties: kind: type: string enum: - pi-durable-node implementation_package: type: string enum: - '@earendil-works/pi-durable' implementation_version: type: string enum: - 1.1.0 runtime_abi: type: string enum: - node-v1 required: - kind - implementation_package - implementation_version - runtime_abi additionalProperties: false - type: object properties: kind: type: string enum: - codex-app-server protocol_revision: type: string enum: - v2 implementation_package: type: string enum: - '@openai/codex' implementation_version: type: string enum: - 0.160.1 client_package: type: string enum: - '@jaminzhou/codex-app-server-client' client_version: type: string enum: - 0.5.3 required: - kind - protocol_revision - implementation_package - implementation_version - client_package - client_version additionalProperties: false - type: object properties: kind: type: string enum: - container-adapter abi_revision: type: number enum: - 2 required: - kind - abi_revision additionalProperties: false configuration_digest: type: string pattern: ^sha256:[0-9a-f]{64}$ required: - abi_revision - cohort_digest - module - native_interface - configuration_digest additionalProperties: false Objects_23: type: object properties: model_wire_dialects: type: array items: $ref: '#/components/schemas/ModelApiFormat' allOf: - minItems: 1 - maxItems: 3 writable_roots: type: array items: type: string allOf: - maxLength: 1024 - pattern: ^\/(?:workspace|state)(?:\/[A-Za-z0-9._-]+)*$ allOf: - minItems: 1 - maxItems: 32 required: - model_wire_dialects - writable_roots additionalProperties: false Objects_24: type: object properties: approval_delivery: type: string enum: - native_same_call - unsupported steering: type: boolean native_session_resume: type: boolean pending_request_resume_after_process_loss: type: boolean required: - approval_delivery - steering - native_session_resume - pending_request_resume_after_process_loss additionalProperties: false 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_47: type: string enum: - stdin - argv_path Union_48: type: string enum: - stream_json - text ModelApiFormat: type: string enum: - openai_chat - openai_responses - anthropic_messages description: >- the request format a model endpoint serves: OpenAI Chat Completions, OpenAI Responses, or Anthropic Messages securitySchemes: bearerAuth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.