> ## 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 Session > Creates a CMA-shaped Session from an agent selector and an environment_id. ## OpenAPI ````yaml /openapi.json post /v1/sessions 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/sessions: post: tags: - sessions summary: Create a Session description: >- Creates a CMA-shaped Session from an `agent` selector and an `environment_id`. The Agent selector resolves one exact Agent Version; the Environment supplies the versioned execution recipe. Optional `budget`, `initial_events`, `metadata`, `resources`, `title`, and ordered `vault_ids` match Claude Managed Agents. Resources may be repositories, files, or memory stores and are snapshotted into the Session. The authenticated API key supplies organization and Workspace authority; the request never creates a Principal or accepts a Deployment, Revision, sandbox profile, or client reference. Up to 50 `initial_events` may start work in the create call. The optional `computer_composition` extension requests a qualified existing Computer with explicit `acted_as` delegation and separate Principal/Agent permissions for Computer use, remote data egress, and remote spend. An unsupported or unauthorized composition is refused; it is never silently omitted. Send an `Idempotency-Key` so an identical retry returns the original Session; changing the composition on replay conflicts. Success returns the Session resource with 201. Checkfu support posture: alpha; hosted. Required evidence journey: session-turn. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities. operationId: sessions.createSession 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: $ref: '#/components/schemas/SessionCreateParams' required: true responses: '201': description: ManagedAgentsSession content: application/json: schema: $ref: '#/components/schemas/ManagedAgentsSession_2' 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: anyOf: - $ref: '#/components/schemas/ValidationMalformedError' - $ref: '#/components/schemas/SessionDriveBadRequestError' '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. | The requested MemoryStore or document does not exist. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ValidationNotFoundError' - $ref: '#/components/schemas/ValidationNotFoundError' - $ref: '#/components/schemas/MemoryNotFoundError' '409': description: >- The request conflicts with the resource's current state. | The MemoryStore write conflicts with the current revision. | An idempotent mutation conflicts with a completed or in-progress request for the same key. | The operation is illegal for the resource's current lifecycle state. | Session history required by the operation has been removed or is unavailable. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ValidationConflictError' - $ref: '#/components/schemas/MemoryConflictError' - $ref: '#/components/schemas/IdempotencyConflictError' - $ref: '#/components/schemas/RuntimeInvalidTransitionError' - $ref: '#/components/schemas/RuntimeSessionHistoryUnavailableError' '422': description: >- No model candidate satisfies the deployment's routing constraints. | The harness does not satisfy the required protocol or capability set. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ModelNoEligibleModelError' - $ref: '#/components/schemas/RuntimeHarnessIncompatibleError' '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' '503': description: >- Authorization could not be evaluated. Retry the same request. | No eligible Runner can currently claim the work. | Platform-managed model credentials are temporarily unavailable. | No qualified provider can yet boot, attach, or stream this Computer, so the operation was refused without changing it. content: application/json: schema: anyOf: - $ref: '#/components/schemas/AuthorizationUnavailableError' - $ref: '#/components/schemas/RuntimeRunnerUnavailableError' - $ref: '#/components/schemas/ModelPlatformSupplyUnavailableError' - $ref: '#/components/schemas/RuntimeComputerUnavailableError' security: - bearerAuth: [] components: schemas: SessionCreateParams: type: object properties: agent: $ref: '#/components/schemas/ManagedAgentsSessionAgentParams' environment_id: $ref: '#/components/schemas/EnvironmentId' budget: $ref: '#/components/schemas/ManagedAgentsBudgetLimit' initial_events: $ref: '#/components/schemas/ManagedAgentsInitialEvents' metadata: $ref: '#/components/schemas/ResourceMetadata' resources: $ref: '#/components/schemas/ManagedAgentsSessionResources' title: anyOf: - type: string - type: 'null' vault_ids: type: array items: $ref: '#/components/schemas/VaultId' capture_policy: type: object properties: schema_version: type: number enum: - 1 semantic_events: type: string enum: - enabled model_io: $ref: '#/components/schemas/Union_360' tool_io: type: string enum: - bounded - artifacts surfaced_thinking: type: string enum: - none - surfaced_only workflow_artifacts: type: string enum: - none - enabled environment_evidence: $ref: '#/components/schemas/Union_361' native_continuation_capsules: type: string enum: - disabled - enabled learning_use: anyOf: - type: object properties: disposition: type: string enum: - disallowed required: - disposition additionalProperties: false - type: object properties: disposition: type: string enum: - requested purposes: type: array items: type: string enum: - memory_curation - evaluation - self_improvement allOf: - maxItems: 6 - minItems: 1 authorized_until: $ref: '#/components/schemas/CurrentTimestamp' required: - disposition - purposes - authorized_until additionalProperties: false required: - schema_version - semantic_events - model_io - tool_io - surfaced_thinking - workflow_artifacts - environment_evidence - native_continuation_capsules - learning_use additionalProperties: false material_review: $ref: '#/components/schemas/SessionMaterialReviewRequest' computer_composition: $ref: '#/components/schemas/WorkEnvironmentCompositionInput' acted_as: $ref: '#/components/schemas/PrincipalId' required: - agent - environment_id additionalProperties: false ManagedAgentsSession_2: type: object properties: id: $ref: '#/components/schemas/SessionId' agent: $ref: '#/components/schemas/ManagedAgentsSessionAgent' archived_at: $ref: '#/components/schemas/Union_315' budget: $ref: '#/components/schemas/Union_316' created_at: $ref: '#/components/schemas/CurrentTimestamp' environment_id: $ref: '#/components/schemas/EnvironmentId' metadata: $ref: '#/components/schemas/ResourceMetadata' outcome_evaluations: $ref: '#/components/schemas/Arrays_43' resources: $ref: '#/components/schemas/Arrays_44' stats: $ref: '#/components/schemas/ManagedAgentsSessionStats' status: $ref: '#/components/schemas/Union_317' title: $ref: '#/components/schemas/Union_318' type: type: string enum: - session updated_at: $ref: '#/components/schemas/CurrentTimestamp' usage: $ref: '#/components/schemas/ManagedAgentsSessionUsage' vault_ids: $ref: '#/components/schemas/Arrays_45' automation_id: anyOf: - $ref: '#/components/schemas/AutomationId' - type: 'null' required: - id - agent - archived_at - budget - created_at - environment_id - metadata - outcome_evaluations - resources - stats - status - title - type - updated_at - usage - vault_ids additionalProperties: false WorkspaceId: type: string pattern: ^wrkspc_[0-9a-f]{32}$ ValidationMalformedError: type: object 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 required: - error additionalProperties: false description: >- The request could not be decoded or violated a declared input constraint. SessionDriveBadRequestError: anyOf: - $ref: '#/components/schemas/ValidationMalformedError' - $ref: '#/components/schemas/ValidationPromptIntegrityReviewRequiredError' description: >- A Session drive request was malformed or requires explicit prompt-integrity review. 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. MemoryNotFoundError: type: object properties: error: type: object properties: type: type: string enum: - memory.not_found message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#memory-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 MemoryStore or document does not exist. 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. MemoryConflictError: type: object properties: error: type: object properties: type: type: string enum: - memory.conflict message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#memory-conflict description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: The MemoryStore write conflicts with the current revision. 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. RuntimeInvalidTransitionError: type: object properties: error: type: object properties: type: type: string enum: - runtime.invalid_transition message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#runtime-invalid-transition description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: The operation is illegal for the resource's current lifecycle state. RuntimeSessionHistoryUnavailableError: type: object properties: error: type: object properties: type: type: string enum: - runtime.session_history_unavailable message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#runtime-session-history-unavailable description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: >- Session history required by the operation has been removed or is unavailable. ModelNoEligibleModelError: type: object properties: error: type: object properties: type: type: string enum: - model.no_eligible_model message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#model-no-eligible-model description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: No model candidate satisfies the deployment's routing constraints. RuntimeHarnessIncompatibleError: type: object properties: error: type: object properties: type: type: string enum: - runtime.harness_incompatible message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#runtime-harness-incompatible description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: The harness does not satisfy the required protocol or capability set. 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. AuthorizationUnavailableError: type: object properties: error: type: object properties: type: type: string enum: - auth.authorization_unavailable message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-authorization-unavailable description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: Authorization could not be evaluated. Retry the same request. RuntimeRunnerUnavailableError: type: object properties: error: type: object properties: type: type: string enum: - runtime.runner_unavailable message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#runtime-runner-unavailable description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: No eligible Runner can currently claim the work. ModelPlatformSupplyUnavailableError: type: object properties: error: type: object properties: type: type: string enum: - model.platform_supply_unavailable message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#model-platform-supply-unavailable description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: Platform-managed model credentials are temporarily unavailable. RuntimeComputerUnavailableError: type: object properties: error: type: object properties: type: type: string enum: - runtime.computer_unavailable message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#runtime-computer-unavailable description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: >- No qualified provider can yet boot, attach, or stream this Computer, so the operation was refused without changing it. ManagedAgentsSessionAgentParams: anyOf: - $ref: '#/components/schemas/AgentId' - $ref: '#/components/schemas/ManagedAgentsAgentParams' - $ref: '#/components/schemas/ManagedAgentsAgentWithOverridesParams' EnvironmentId: type: string pattern: ^env_[0-9a-f]{32}$ ManagedAgentsBudgetLimit: type: object properties: type: type: string enum: - limit max_list_cost: type: object properties: amount: type: string pattern: ^[1-9][0-9]*$ currency: type: string enum: - USD required: - amount - currency additionalProperties: false required: - type - max_list_cost additionalProperties: false ManagedAgentsInitialEvents: type: array items: anyOf: - $ref: '#/components/schemas/ManagedAgentsUserMessageEventParams' - $ref: '#/components/schemas/ManagedAgentsUserDefineOutcomeEventParams' allOf: - maxItems: 50 ResourceMetadata: type: object additionalProperties: type: string allOf: - maxLength: 512 allOf: - propertyNames: type: string allOf: - minLength: 1 - maxLength: 64 - maxProperties: 16 description: at most 16 correlation pairs with keys of 1 to 64 characters ManagedAgentsSessionResources: type: array items: $ref: '#/components/schemas/ManagedAgentsSessionResourceParams' VaultId: type: string pattern: ^vlt_[0-9a-f]{32}$ Union_360: type: string enum: - none - digests - content Union_361: type: string enum: - manifests - selected_content - checkpoints CurrentTimestamp: type: string allOf: - maxLength: 24 - pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ x-checkfu-current-timestamp: true description: A canonical UTC ISO-8601 timestamp with millisecond precision. SessionMaterialReviewRequest: type: object properties: review: $ref: '#/components/schemas/SignedWorkloadReview' ingress_policy: $ref: '#/components/schemas/SessionIngressPolicy' required: - review - ingress_policy additionalProperties: false description: >- Signed review binding the resolved Agent, Environment, build, verified resource bodies, initial input, and future-input policy. WorkEnvironmentCompositionInput: type: object properties: input_type: type: string enum: - composition execution: $ref: '#/components/schemas/WorkEnvironmentInput' computer: type: object properties: requirements: $ref: '#/components/schemas/WorkEnvironmentInput' affinity: anyOf: - type: object properties: type: type: string enum: - same_execution_environment required_shared: type: array items: type: string enum: - display - filesystem - network - process_namespace allOf: - maxItems: 4 required: - type - required_shared additionalProperties: false - type: object properties: type: type: string enum: - remote_permitted required: - type additionalProperties: false existing_computer: anyOf: - $ref: '#/components/schemas/ComputerId' - type: 'null' required: - requirements additionalProperties: false ownership: $ref: '#/components/schemas/Objects_223' remote: $ref: '#/components/schemas/Objects_224' required: - input_type - execution - computer additionalProperties: false description: >- Explicit execution requirements plus a requested Computer overlay, with affinity, ownership, and remote-authorization policy for one joint admission. PrincipalId: type: string pattern: ^prin_[0-9a-f]{32}$ SessionId: type: string pattern: ^sess_[0-9a-f]{32}$ ManagedAgentsSessionAgent: type: object properties: id: $ref: '#/components/schemas/AgentId' connection_bindings: $ref: '#/components/schemas/Arrays_7' description: $ref: '#/components/schemas/Union_31' harness: $ref: '#/components/schemas/ManagedAgentsHarnessReference' mcp_servers: $ref: '#/components/schemas/Arrays_8' model: $ref: '#/components/schemas/ManagedAgentsModelConfig' name: type: string allOf: - minLength: 1 - maxLength: 255 skills: $ref: '#/components/schemas/Arrays_9' system: $ref: '#/components/schemas/Union_33' tools: $ref: '#/components/schemas/Arrays_10' browser: anyOf: - $ref: '#/components/schemas/Objects_14' - type: 'null' skill_selection: $ref: '#/components/schemas/ManagedAgentsAgentSkillSelection' type: type: string enum: - agent version: type: integer exclusiveMinimum: 0 required: - id - connection_bindings - description - harness - mcp_servers - model - name - skills - system - tools - type - version additionalProperties: false Union_315: anyOf: - $ref: '#/components/schemas/CurrentTimestamp' - type: 'null' Union_316: anyOf: - $ref: '#/components/schemas/ManagedAgentsBudgetLimit' - type: 'null' Arrays_43: type: array items: $ref: '#/components/schemas/ManagedAgentsOutcomeEvaluationResource' Arrays_44: type: array items: $ref: '#/components/schemas/ManagedAgentsSessionResource' ManagedAgentsSessionStats: type: object properties: active_seconds: type: number minimum: 0 duration_seconds: type: number minimum: 0 additionalProperties: false Union_317: type: string enum: - rescheduling - running - idle - terminated Union_318: anyOf: - type: string - type: 'null' ManagedAgentsSessionUsage: type: object properties: active_seconds: type: number minimum: 0 cache_creation: $ref: '#/components/schemas/ManagedAgentsCacheCreationUsage' cache_read_input_tokens: type: integer minimum: 0 input_tokens: type: integer minimum: 0 list_cost: anyOf: - $ref: '#/components/schemas/MonetaryAmount' - type: 'null' output_tokens: type: integer minimum: 0 server_tool_use: anyOf: - $ref: '#/components/schemas/ManagedAgentsServerToolUsage' - type: 'null' additionalProperties: false Arrays_45: type: array items: $ref: '#/components/schemas/VaultId' AutomationId: type: string pattern: ^auto_[0-9a-f]{32}$ ValidationPromptIntegrityReviewRequiredError: type: object properties: error: type: object properties: type: type: string enum: - validation.prompt_integrity_review_required message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#validation-prompt-integrity-review-required description: Stable public documentation and remedy for this error type. review: type: object properties: analyzer_version: type: string enum: - unicode-17.0.0-uts39-r32-checkfu-1 normalized: type: string findings: type: array items: $ref: '#/components/schemas/Union_324' allOf: - minItems: 1 - maxItems: 256 required: - analyzer_version - normalized - findings additionalProperties: false required: - type - message - more - review additionalProperties: false required: - error additionalProperties: false description: The request contains deceptive Unicode and requires an explicit review. 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. 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 ManagedAgentsAgentWithOverridesParams: type: object properties: type: type: string enum: - agent_with_overrides id: $ref: '#/components/schemas/AgentId' version: type: integer exclusiveMinimum: 0 harness: $ref: '#/components/schemas/ManagedAgentsHarnessReference' mcp_servers: $ref: '#/components/schemas/Arrays_4' model: $ref: '#/components/schemas/ManagedAgentsModelConfigParams' skills: type: array items: $ref: '#/components/schemas/Union_28' skill_selection: anyOf: - $ref: '#/components/schemas/AgentSkillSelectionParams' - type: 'null' system: anyOf: - $ref: '#/components/schemas/ManagedAgentsSessionSystem' - type: 'null' tools: $ref: '#/components/schemas/Arrays_5' required: - type - id additionalProperties: false ManagedAgentsUserMessageEventParams: type: object properties: type: type: string enum: - user.message content: type: array items: $ref: '#/components/schemas/ManagedAgentsContentBlock' required: - type - content additionalProperties: false ManagedAgentsUserDefineOutcomeEventParams: type: object properties: type: type: string enum: - user.define_outcome description: type: string rubric: $ref: '#/components/schemas/ManagedAgentsOutcomeRubricParams' max_iterations: anyOf: - type: integer allOf: - minimum: 1 maximum: 20 - type: 'null' required: - type - description - rubric additionalProperties: false ManagedAgentsSessionResourceParams: anyOf: - $ref: '#/components/schemas/ManagedAgentsGitHubRepositoryResourceParams' - $ref: '#/components/schemas/ManagedAgentsFileResourceParams' - $ref: '#/components/schemas/ManagedAgentsMemoryStoreResourceParam' - $ref: '#/components/schemas/ManagedAgentsComputerResourceParam' SignedWorkloadReview: type: object properties: statement: type: object properties: schema_revision: type: string enum: - checkfu:workload-review@1 workspace_id: $ref: '#/components/schemas/WorkspaceId' binding: $ref: '#/components/schemas/WorkloadReviewBinding' claim: type: string enum: - organization_authored_reviewed_controlled_inputs issued_at: $ref: '#/components/schemas/CurrentTimestamp' expires_at: $ref: '#/components/schemas/CurrentTimestamp' required: - schema_revision - workspace_id - binding - claim - issued_at - expires_at additionalProperties: false description: >- Workspace-scoped review of exact material, valid only during its stated interval. key_id: type: string allOf: - minLength: 1 - maxLength: 128 - pattern: ^[A-Za-z0-9][A-Za-z0-9._:@+-]*$ signature: type: string pattern: ^[A-Za-z0-9_-]{86}$ required: - statement - key_id - signature additionalProperties: false description: >- Ed25519 review envelope authenticated against current Workspace signer policy. SessionIngressPolicy: type: object properties: schema_revision: type: string enum: - checkfu:session-ingress-policy@1 api_key_ids: type: array items: $ref: '#/components/schemas/ApiKeyId' allOf: - maxItems: 100 required: - schema_revision - api_key_ids additionalProperties: false description: >- API key identities explicitly allowed to submit later Session input. An empty list permits only the initial input covered by the material review. WorkEnvironmentInput: anyOf: - type: object properties: input_type: type: string enum: - preset preset: type: string enum: - conversation_only - sandbox_ephemeral - sandbox_durable - browser_isolated - browser_shared_profile - desktop_isolated - desktop_shared_filesystem - connected_computer overrides: type: object properties: execution: $ref: '#/components/schemas/Arrays_47' computer_capabilities: $ref: '#/components/schemas/WorkEnvironmentComputerCapabilities' placement: $ref: '#/components/schemas/Arrays_48' locality: type: object properties: regions: $ref: '#/components/schemas/Arrays_49' residency_required: type: boolean required: - regions - residency_required additionalProperties: false resources: type: object properties: minimum_vcpu: anyOf: - type: integer allOf: - exclusiveMinimum: 0 - maximum: 1024 - type: 'null' minimum_memory_mib: anyOf: - type: integer allOf: - exclusiveMinimum: 0 - maximum: 4194304 - type: 'null' minimum_disk_mib: anyOf: - type: integer allOf: - exclusiveMinimum: 0 - maximum: 1073741824 - type: 'null' gpu: $ref: '#/components/schemas/Union_343' required: - minimum_vcpu - minimum_memory_mib - minimum_disk_mib - gpu additionalProperties: false additionalProperties: false required: - input_type - preset additionalProperties: false - type: object properties: input_type: type: string enum: - requirements requirements: $ref: '#/components/schemas/WorkEnvironmentRequirements' required: - input_type - requirements additionalProperties: false description: >- Explicit requirements or a versioned convenience preset with safe overrides. ComputerId: type: string pattern: ^comp_[0-9a-f]{32}$ Objects_223: type: object properties: execution: $ref: '#/components/schemas/Arrays_51' computer: $ref: '#/components/schemas/Arrays_51' required: - execution - computer additionalProperties: false Objects_224: type: object properties: spend_authorized: type: boolean data_egress_authorized: type: boolean required: - spend_authorized - data_egress_authorized additionalProperties: false Arrays_7: type: array items: $ref: '#/components/schemas/ManagedAgentsConnectionBinding' allOf: - maxItems: 20 Union_31: anyOf: - type: string - type: 'null' ManagedAgentsHarnessReference: type: string allOf: - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})(?:@(?:latest|[1-9][0-9]{0,8}))?$ description: >- a harness catalog name this deployment serves: claude-code, cline, codex, cursor, deepagents, deepseek, hermes, openclaw, openclaw-connected, opencode, pi Arrays_8: type: array items: $ref: '#/components/schemas/Union_27' ManagedAgentsModelConfig: type: object properties: id: type: string effort: anyOf: - type: object properties: type: type: string enum: - low required: - type additionalProperties: false - type: object properties: type: type: string enum: - medium required: - type additionalProperties: false - type: object properties: type: type: string enum: - high required: - type additionalProperties: false - type: object properties: type: type: string enum: - xhigh required: - type additionalProperties: false - type: object properties: type: type: string enum: - max required: - type additionalProperties: false inference_geo: type: string enum: - global - us speed: type: string enum: - standard - fast provider: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ model_credential_id: $ref: '#/components/schemas/ModelCredentialId' required: - id additionalProperties: false Arrays_9: type: array items: $ref: '#/components/schemas/Union_32' Union_33: anyOf: - type: string - type: 'null' Arrays_10: type: array items: $ref: '#/components/schemas/ManagedAgentsTool' Objects_14: type: object properties: tier: type: string enum: - isolate - chromium required: - tier additionalProperties: false ManagedAgentsAgentSkillSelection: anyOf: - type: object properties: type: type: string enum: - listed skills: type: array items: $ref: '#/components/schemas/Union_32' allOf: - minItems: 1 - maxItems: 100 required: - type - skills additionalProperties: false - type: object properties: type: type: string enum: - workspace required: - type additionalProperties: false ManagedAgentsOutcomeEvaluationResource: type: object properties: completed_at: anyOf: - $ref: '#/components/schemas/CurrentTimestamp' - type: 'null' description: type: string explanation: anyOf: - type: string - type: 'null' iteration: type: integer minimum: 0 outcome_id: $ref: '#/components/schemas/OutcomeId' result: type: string type: type: string enum: - outcome_evaluation required: - completed_at - description - explanation - iteration - outcome_id - result - type additionalProperties: false ManagedAgentsSessionResource: anyOf: - $ref: '#/components/schemas/ManagedAgentsGitHubRepositoryResource' - $ref: '#/components/schemas/ManagedAgentsFileResource' - $ref: '#/components/schemas/ManagedAgentsMemoryStoreResource' - $ref: '#/components/schemas/ManagedAgentsComputerResource' ManagedAgentsCacheCreationUsage: type: object properties: ephemeral_1h_input_tokens: type: integer minimum: 0 ephemeral_5m_input_tokens: type: integer minimum: 0 additionalProperties: false MonetaryAmount: type: object properties: amount: type: string pattern: ^(0|[1-9][0-9]*)$ currency: type: string enum: - USD required: - amount - currency additionalProperties: false ManagedAgentsServerToolUsage: type: object properties: web_fetch_requests: type: integer minimum: 0 web_search_requests: type: integer minimum: 0 additionalProperties: false Union_324: anyOf: - type: object properties: kind: type: string enum: - mixed_script_confusable utf16_offset: type: integer minimum: 0 code_point: type: string pattern: ^U\+[0-9A-F]{4,6}$ replacement: type: string allOf: - maxLength: 5 answer_id: type: string value_index: type: integer minimum: 0 required: - kind - utf16_offset - code_point - replacement additionalProperties: false - type: object properties: kind: type: string enum: - bidirectional_control utf16_offset: type: integer minimum: 0 code_point: type: string pattern: ^U\+[0-9A-F]{4,6}$ answer_id: type: string value_index: type: integer minimum: 0 required: - kind - utf16_offset - code_point additionalProperties: false Arrays_4: type: array items: $ref: '#/components/schemas/Union_27' allOf: - maxItems: 20 ManagedAgentsModelConfigParams: anyOf: - type: string - type: object properties: id: type: string effort: anyOf: - anyOf: - $ref: '#/components/schemas/Union_23' - $ref: '#/components/schemas/Union_24' - type: 'null' inference_geo: anyOf: - $ref: '#/components/schemas/Union_11' - type: 'null' speed: anyOf: - type: string enum: - standard - fast - type: 'null' provider: anyOf: - type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ - type: 'null' model_credential_id: anyOf: - $ref: '#/components/schemas/ModelCredentialId' - type: 'null' required: - id additionalProperties: false Union_28: anyOf: - type: object properties: type: type: string enum: - anthropic skill_id: type: string allOf: - maxLength: 4194304 version: anyOf: - type: string allOf: - maxLength: 4194304 - type: 'null' required: - type - skill_id additionalProperties: false - type: object properties: type: type: string enum: - custom skill_id: type: string allOf: - maxLength: 4194304 version: anyOf: - type: string allOf: - maxLength: 4194304 - type: 'null' required: - type - skill_id additionalProperties: false AgentSkillSelectionParams: anyOf: - type: object properties: type: type: string enum: - listed skills: type: array items: $ref: '#/components/schemas/Union_28' allOf: - minItems: 1 - maxItems: 100 required: - type - skills additionalProperties: false - type: object properties: type: type: string enum: - workspace required: - type additionalProperties: false ManagedAgentsSessionSystem: type: string Arrays_5: type: array items: $ref: '#/components/schemas/ManagedAgentsToolParams' allOf: - maxItems: 128 ManagedAgentsContentBlock: anyOf: - type: object properties: type: type: string enum: - text text: type: string required: - type - text additionalProperties: false - type: object properties: type: type: string enum: - image source: anyOf: - type: object properties: type: type: string enum: - base64 data: type: string media_type: type: string required: - type - data - media_type additionalProperties: false - type: object properties: type: type: string enum: - url url: type: string required: - type - url additionalProperties: false - type: object properties: type: type: string enum: - file file_id: $ref: '#/components/schemas/FileId' required: - type - file_id additionalProperties: false required: - type - source additionalProperties: false - type: object properties: type: type: string enum: - document source: anyOf: - type: object properties: type: type: string enum: - base64 data: type: string media_type: type: string required: - type - data - media_type additionalProperties: false - type: object properties: type: type: string enum: - text data: type: string media_type: type: string enum: - text/plain required: - type - data - media_type additionalProperties: false - type: object properties: type: type: string enum: - url url: type: string required: - type - url additionalProperties: false - type: object properties: type: type: string enum: - file file_id: $ref: '#/components/schemas/FileId' required: - type - file_id additionalProperties: false context: anyOf: - type: string - type: 'null' title: anyOf: - type: string - type: 'null' required: - type - source additionalProperties: false - type: object properties: type: type: string enum: - redacted required: - type additionalProperties: false ManagedAgentsOutcomeRubricParams: anyOf: - type: object properties: type: type: string enum: - file file_id: $ref: '#/components/schemas/FileId' required: - type - file_id additionalProperties: false - type: object properties: type: type: string enum: - text content: type: string allOf: - maxLength: 262144 required: - type - content additionalProperties: false ManagedAgentsGitHubRepositoryResourceParams: type: object properties: authorization_token: type: string type: type: string enum: - github_repository url: $ref: '#/components/schemas/ManagedAgentsGitHubRepositoryUrl' checkout: anyOf: - $ref: '#/components/schemas/ManagedAgentsRepositoryCheckout' - type: 'null' mount_path: anyOf: - $ref: '#/components/schemas/ManagedAgentsGitHubRepositoryMountPath' - type: 'null' required: - authorization_token - type - url additionalProperties: false ManagedAgentsFileResourceParams: type: object properties: file_id: $ref: '#/components/schemas/FileId' type: type: string enum: - file mount_path: anyOf: - $ref: '#/components/schemas/ManagedAgentsFileResourceMountPath' - type: 'null' required: - file_id - type additionalProperties: false ManagedAgentsMemoryStoreResourceParam: type: object properties: memory_store_id: $ref: '#/components/schemas/MemoryStoreId' type: type: string enum: - memory_store selection: anyOf: - type: object properties: kind: type: string enum: - ref ref: $ref: '#/components/schemas/Union_124' required: - kind - ref additionalProperties: false - type: object properties: kind: type: string enum: - version version: $ref: '#/components/schemas/MemoryVersionId' required: - kind - version additionalProperties: false access: anyOf: - type: string enum: - read_write - read_only - type: 'null' instructions: anyOf: - type: string allOf: - minLength: 1 - maxLength: 4096 - type: 'null' required: - memory_store_id - type additionalProperties: false ManagedAgentsComputerResourceParam: type: object properties: computer_id: $ref: '#/components/schemas/ComputerId' type: type: string enum: - computer instructions: anyOf: - type: string allOf: - minLength: 1 - maxLength: 4096 - type: 'null' required: - computer_id - type additionalProperties: false WorkloadReviewBinding: type: object properties: configuration_digest: type: string pattern: ^sha256:[0-9a-f]{64}$ input_manifest_digest: type: string pattern: ^sha256:[0-9a-f]{64}$ required: - configuration_digest - input_manifest_digest additionalProperties: false description: >- Exact configuration and input-manifest fingerprints compiled by the review owner. ApiKeyId: type: string pattern: ^akey_[0-9a-f]{32}$ Arrays_47: type: array items: $ref: '#/components/schemas/Union_339' allOf: - maxItems: 6 WorkEnvironmentComputerCapabilities: type: object properties: observation: $ref: '#/components/schemas/WorkEnvironmentComputerObservationNeeds' actions: $ref: '#/components/schemas/WorkEnvironmentComputerActionNeeds' additionalProperties: false allOf: - minProperties: 1 Arrays_48: type: array items: $ref: '#/components/schemas/Union_342' allOf: - maxItems: 3 Arrays_49: type: array items: type: string allOf: - minLength: 1 - maxLength: 64 - pattern: ^[a-z0-9][a-z0-9-]*$ allOf: - maxItems: 32 Union_343: type: string enum: - forbidden - optional - required WorkEnvironmentRequirements: type: object properties: schema_version: type: number enum: - 1 execution: $ref: '#/components/schemas/Arrays_47' lifetime: $ref: '#/components/schemas/Union_344' presentation: $ref: '#/components/schemas/Union_345' human_access: $ref: '#/components/schemas/Union_346' computer_capabilities: $ref: '#/components/schemas/WorkEnvironmentComputerCapabilities' placement: $ref: '#/components/schemas/Arrays_48' isolation: type: object properties: filesystem: $ref: '#/components/schemas/Union_347' browser_profile: $ref: '#/components/schemas/Union_347' process_namespace: $ref: '#/components/schemas/Union_347' credentials: type: string enum: - grant_bound - profile_shared clipboard: $ref: '#/components/schemas/Union_348' downloads: $ref: '#/components/schemas/Union_347' required: - filesystem - browser_profile - process_namespace - credentials - clipboard - downloads additionalProperties: false recovery: $ref: '#/components/schemas/Union_349' retention: $ref: '#/components/schemas/WorkEnvironmentRetention' network: $ref: '#/components/schemas/WorkEnvironmentNetwork' locality: $ref: '#/components/schemas/WorkEnvironmentLocality' resources: $ref: '#/components/schemas/WorkEnvironmentResources' required: - schema_version - execution - lifetime - presentation - human_access - placement - isolation - recovery - retention - network - locality - resources additionalProperties: false Arrays_51: type: array items: $ref: '#/components/schemas/Union_354' allOf: - maxItems: 2 ManagedAgentsConnectionBinding: type: object properties: name: type: string allOf: - minLength: 1 - maxLength: 255 connection_id: $ref: '#/components/schemas/ConnectionId' provider: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ provider_package_digest: type: string pattern: ^sha256:[0-9a-f]{64}$ connection_revision_id: $ref: '#/components/schemas/ConnectionRevisionId' capability_snapshot_id: $ref: '#/components/schemas/CapabilitySnapshotId' capability_snapshot_digest: type: string pattern: ^sha256:[0-9a-f]{64}$ tools: type: array items: type: object properties: name: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ digest: type: string pattern: ^sha256:[0-9a-f]{64}$ required: - name - digest additionalProperties: false allOf: - maxItems: 1000 required: - name - connection_id - provider - provider_package_digest - connection_revision_id - capability_snapshot_id - capability_snapshot_digest - tools additionalProperties: false description: >- Read-only Connection revision, capability snapshot and selected tool digests frozen by this Agent Version; never credentials or supplier handles. Union_27: anyOf: - type: object properties: type: type: string enum: - url name: type: string allOf: - minLength: 1 - maxLength: 255 url: type: string allOf: - minLength: 1 - maxLength: 2048 required: - type - name - url additionalProperties: false - $ref: '#/components/schemas/ManagedAgentsConnectionMcpServerParams' ModelCredentialId: type: string pattern: ^mcred_[0-9a-f]{32}$ Union_32: anyOf: - type: object properties: type: type: string enum: - anthropic skill_id: type: string version: type: string required: - type - skill_id - version additionalProperties: false - type: object properties: type: type: string enum: - custom skill_id: type: string version: type: string required: - type - skill_id - version additionalProperties: false ManagedAgentsTool: anyOf: - anyOf: - type: object properties: type: type: string enum: - agent_toolset_20260401 - computer_toolset_20260801 configs: type: array items: anyOf: - type: object properties: name: type: string enum: - bash type: type: string enum: - bash enabled: type: boolean permission_policy: $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' required: - name - type - enabled - permission_policy additionalProperties: false - type: object properties: name: type: string enum: - edit type: type: string enum: - edit enabled: type: boolean permission_policy: $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' required: - name - type - enabled - permission_policy additionalProperties: false - type: object properties: name: type: string enum: - glob type: type: string enum: - glob enabled: type: boolean permission_policy: $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' required: - name - type - enabled - permission_policy additionalProperties: false - type: object properties: name: type: string enum: - grep type: type: string enum: - grep enabled: type: boolean permission_policy: $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' required: - name - type - enabled - permission_policy additionalProperties: false - type: object properties: name: type: string enum: - read type: type: string enum: - read enabled: type: boolean permission_policy: $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' required: - name - type - enabled - permission_policy additionalProperties: false - type: object properties: name: type: string enum: - web_fetch type: type: string enum: - web_fetch enabled: type: boolean permission_policy: $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' allowed_domains: $ref: '#/components/schemas/Arrays_6' blocked_domains: $ref: '#/components/schemas/Arrays_6' max_content_tokens: anyOf: - type: integer exclusiveMinimum: 0 - type: 'null' required: - name - type - enabled - permission_policy additionalProperties: false - type: object properties: name: type: string enum: - web_search type: type: string enum: - web_search enabled: type: boolean permission_policy: $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' allowed_domains: $ref: '#/components/schemas/Arrays_6' blocked_domains: $ref: '#/components/schemas/Arrays_6' user_location: anyOf: - $ref: '#/components/schemas/Objects_11' - type: 'null' required: - name - type - enabled - permission_policy additionalProperties: false - type: object properties: name: type: string enum: - write type: type: string enum: - write enabled: type: boolean permission_policy: $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' required: - name - type - enabled - permission_policy additionalProperties: false default_config: $ref: '#/components/schemas/Objects_15' required: - type - configs - default_config additionalProperties: false - $ref: '#/components/schemas/ManagedAgentsComputerToolset' - type: object properties: type: type: string enum: - mcp_toolset mcp_server_name: type: string allOf: - minLength: 1 - maxLength: 255 configs: type: array items: type: object properties: name: type: string enabled: type: boolean permission_policy: $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' required: - name - enabled - permission_policy additionalProperties: false default_config: $ref: '#/components/schemas/Objects_15' required: - type - mcp_server_name - configs - default_config additionalProperties: false - $ref: '#/components/schemas/Objects_13' - $ref: '#/components/schemas/ManagedAgentsManagedTool' OutcomeId: type: string pattern: ^outc_[0-9a-f]{32}$ ManagedAgentsGitHubRepositoryResource: type: object properties: id: $ref: '#/components/schemas/SessionResourceId' created_at: $ref: '#/components/schemas/CurrentTimestamp' updated_at: $ref: '#/components/schemas/CurrentTimestamp' mount_path: $ref: '#/components/schemas/CurrentMountPath' type: type: string enum: - github_repository url: $ref: '#/components/schemas/ManagedAgentsGitHubRepositoryUrl' checkout: anyOf: - $ref: '#/components/schemas/ManagedAgentsRepositoryCheckout' - type: 'null' required: - id - created_at - updated_at - mount_path - type - url additionalProperties: false ManagedAgentsFileResource: type: object properties: id: $ref: '#/components/schemas/SessionResourceId' created_at: $ref: '#/components/schemas/CurrentTimestamp' updated_at: $ref: '#/components/schemas/CurrentTimestamp' file_id: $ref: '#/components/schemas/FileId' mount_path: $ref: '#/components/schemas/CurrentMountPath' type: type: string enum: - file required: - id - created_at - updated_at - file_id - mount_path - type additionalProperties: false ManagedAgentsMemoryStoreResource: type: object properties: memory_store_id: $ref: '#/components/schemas/MemoryStoreId' type: type: string enum: - memory_store selection: anyOf: - type: object properties: kind: type: string enum: - ref ref: $ref: '#/components/schemas/Union_124' required: - kind - ref additionalProperties: false - type: object properties: kind: type: string enum: - version version: $ref: '#/components/schemas/MemoryVersionId' required: - kind - version additionalProperties: false access: anyOf: - type: string enum: - read_write - read_only - type: 'null' description: type: string instructions: anyOf: - type: string allOf: - minLength: 1 - maxLength: 4096 - type: 'null' mount_path: anyOf: - $ref: '#/components/schemas/CurrentMountPath' - type: 'null' name: anyOf: - type: string - type: 'null' required: - memory_store_id - type additionalProperties: false ManagedAgentsComputerResource: type: object properties: computer_id: $ref: '#/components/schemas/ComputerId' type: type: string enum: - computer instructions: anyOf: - type: string allOf: - minLength: 1 - maxLength: 4096 - type: 'null' required: - computer_id - type additionalProperties: false Union_23: type: string enum: - low - medium - high - xhigh - max Union_24: anyOf: - type: object properties: type: type: string enum: - low required: - type additionalProperties: false - type: object properties: type: type: string enum: - medium required: - type additionalProperties: false - type: object properties: type: type: string enum: - high required: - type additionalProperties: false - type: object properties: type: type: string enum: - xhigh required: - type additionalProperties: false - type: object properties: type: type: string enum: - max required: - type additionalProperties: false Union_11: type: string enum: - global - us ManagedAgentsToolParams: anyOf: - type: object properties: type: type: string enum: - agent_toolset_20260401 configs: type: array items: $ref: '#/components/schemas/ManagedAgentsAgentToolConfigParams' default_config: anyOf: - $ref: '#/components/schemas/Objects_12' - type: 'null' required: - type additionalProperties: false - type: object properties: type: type: string enum: - mcp_toolset mcp_server_name: type: string allOf: - minLength: 1 - maxLength: 255 configs: type: array items: type: object properties: name: type: string allOf: - minLength: 1 - maxLength: 128 enabled: anyOf: - type: boolean - type: 'null' permission_policy: anyOf: - $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' - type: 'null' required: - name additionalProperties: false default_config: anyOf: - $ref: '#/components/schemas/Objects_12' - type: 'null' required: - type - mcp_server_name additionalProperties: false - $ref: '#/components/schemas/Objects_13' - $ref: '#/components/schemas/ManagedAgentsManagedTool' - $ref: '#/components/schemas/ManagedAgentsComputerToolset' FileId: type: string pattern: ^file_[0-9a-f]{32}$ ManagedAgentsGitHubRepositoryUrl: type: string ManagedAgentsRepositoryCheckout: anyOf: - type: object properties: type: type: string enum: - branch name: type: string allOf: - minLength: 1 required: - type - name additionalProperties: false - type: object properties: type: type: string enum: - commit sha: type: string pattern: ^[0-9a-f]{40}$ required: - type - sha additionalProperties: false ManagedAgentsGitHubRepositoryMountPath: type: string allOf: - minLength: 2 - maxLength: 1024 ManagedAgentsFileResourceMountPath: type: string allOf: - minLength: 2 - maxLength: 1024 MemoryStoreId: type: string pattern: ^memstore_[0-9a-f]{32}$ Union_124: anyOf: - type: object properties: kind: type: string enum: - canonical required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - session session: $ref: '#/components/schemas/SessionId' required: - kind - session additionalProperties: false - type: object properties: kind: type: string enum: - proposal proposal: $ref: '#/components/schemas/MemoryProposalId' required: - kind - proposal additionalProperties: false - type: object properties: kind: type: string enum: - curation run: $ref: '#/components/schemas/CurationRunId' required: - kind - run additionalProperties: false MemoryVersionId: type: string pattern: ^memver_[0-9a-f]{32}$ Union_339: type: string enum: - shell - filesystem - network_server - browser_dom - browser_visual - desktop_gui WorkEnvironmentComputerObservationNeeds: type: object properties: accessibility_tree: type: string enum: - required - optional screenshot: type: string enum: - required - optional window_inventory: type: string enum: - required - optional additionalProperties: false allOf: - minProperties: 1 WorkEnvironmentComputerActionNeeds: type: object properties: navigate: type: string enum: - required - optional click: type: string enum: - required - optional type_text: type: string enum: - required - optional keypress: type: string enum: - required - optional scroll: type: string enum: - required - optional switch_target: type: string enum: - required - optional close_target: type: string enum: - required - optional drag: type: string enum: - required - optional accessible_node: type: string enum: - required - optional additionalProperties: false allOf: - minProperties: 1 Union_342: type: string enum: - managed - local - connected Union_344: type: string enum: - run - session - durable Union_345: type: string enum: - none - browser - desktop Union_346: type: string enum: - none - observe - exclusive_takeover Union_347: type: string enum: - attachment - application - scope_shared Union_348: type: string enum: - disabled - attachment - scope_shared Union_349: type: string enum: - none - filesystem - browser_profile - full_instance WorkEnvironmentRetention: type: object properties: mode: $ref: '#/components/schemas/Union_350' maximum_seconds: anyOf: - type: integer allOf: - exclusiveMinimum: 0 - maximum: 315360000 - type: 'null' export: type: string enum: - forbidden - allowed required: - mode - maximum_seconds - export additionalProperties: false description: >- Retention duration, durability mode, and export policy for a work environment. WorkEnvironmentNetwork: anyOf: - type: object properties: mode: $ref: '#/components/schemas/Union_351' policy: anyOf: - type: object properties: action_policy_id: $ref: '#/components/schemas/ActionPolicyId' action_policy_version: type: integer exclusiveMinimum: 0 required: - action_policy_id - action_policy_version additionalProperties: false - type: 'null' required: - mode - policy additionalProperties: false - $ref: '#/components/schemas/Union_352' description: >- Concrete network destinations and enforcement requirements, or a retained action-policy reference that cannot authorize network egress. WorkEnvironmentLocality: type: object properties: regions: $ref: '#/components/schemas/Arrays_49' residency_required: type: boolean required: - regions - residency_required additionalProperties: false description: >- Ordered eligible regions and residency requirement for a work environment. WorkEnvironmentResources: type: object properties: minimum_vcpu: anyOf: - type: integer allOf: - exclusiveMinimum: 0 - maximum: 1024 - type: 'null' minimum_memory_mib: anyOf: - type: integer allOf: - exclusiveMinimum: 0 - maximum: 4194304 - type: 'null' minimum_disk_mib: anyOf: - type: integer allOf: - exclusiveMinimum: 0 - maximum: 1073741824 - type: 'null' gpu: $ref: '#/components/schemas/Union_343' required: - minimum_vcpu - minimum_memory_mib - minimum_disk_mib - gpu additionalProperties: false description: >- Minimum compute, memory, disk, and GPU requirements for a work environment. Union_354: type: string enum: - customer - managed ConnectionId: type: string pattern: ^conn_[0-9a-f]{32}$ ConnectionRevisionId: type: string pattern: ^crev_[0-9a-f]{32}$ CapabilitySnapshotId: type: string pattern: ^csnap_[0-9a-f]{32}$ ManagedAgentsConnectionMcpServerParams: type: object properties: type: type: string enum: - connection name: type: string allOf: - minLength: 1 - maxLength: 255 connection_id: $ref: '#/components/schemas/ConnectionId' required: - type - name - connection_id additionalProperties: false description: >- An explicit governed Connection account exposed under a named MCP toolset. ManagedAgentsPermissionPolicy: anyOf: - type: object properties: type: type: string enum: - always_allow required: - type additionalProperties: false - type: object properties: type: type: string enum: - always_ask required: - type additionalProperties: false Arrays_6: type: array items: type: string allOf: - minLength: 1 - maxLength: 255 allOf: - minItems: 1 - maxItems: 64 Objects_11: type: object properties: type: type: string enum: - approximate city: anyOf: - type: string - type: 'null' country: anyOf: - $ref: '#/components/schemas/ManagedAgentsIsoCountryCode' - type: 'null' region: anyOf: - type: string - type: 'null' timezone: anyOf: - $ref: '#/components/schemas/ManagedAgentsIanaTimeZone' - type: 'null' required: - type additionalProperties: false Objects_15: type: object properties: enabled: type: boolean permission_policy: $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' required: - enabled - permission_policy additionalProperties: false ManagedAgentsComputerToolset: type: object properties: type: type: string enum: - computer_toolset_20260801 required: - type additionalProperties: false Objects_13: type: object properties: type: type: string enum: - custom name: type: string allOf: - minLength: 1 - maxLength: 128 - pattern: ^[A-Za-z0-9_-]+$ description: type: string allOf: - minLength: 1 input_schema: $ref: '#/components/schemas/ManagedAgentsCustomToolInputSchema' required: - type - name - description - input_schema additionalProperties: false ManagedAgentsManagedTool: type: object properties: type: type: string enum: - managed_tool managed_tool_id: $ref: '#/components/schemas/ManagedToolId' managed_tool_release_id: $ref: '#/components/schemas/ManagedToolReleaseId' maximum_charge_microusd: type: integer allOf: - minimum: 0 - maximum: 9007199254740991 required: - type - managed_tool_id - managed_tool_release_id - maximum_charge_microusd additionalProperties: false SessionResourceId: type: string pattern: ^sesrsc_[0-9a-f]{32}$ CurrentMountPath: type: string allOf: - minLength: 2 - maxLength: 1024 ManagedAgentsAgentToolConfigParams: anyOf: - type: object properties: name: type: string enum: - bash type: type: string enum: - bash enabled: anyOf: - type: boolean - type: 'null' permission_policy: anyOf: - $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' - type: 'null' required: - name additionalProperties: false - type: object properties: name: type: string enum: - edit type: type: string enum: - edit enabled: anyOf: - type: boolean - type: 'null' permission_policy: anyOf: - $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' - type: 'null' required: - name additionalProperties: false - type: object properties: name: type: string enum: - glob type: type: string enum: - glob enabled: anyOf: - type: boolean - type: 'null' permission_policy: anyOf: - $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' - type: 'null' required: - name additionalProperties: false - type: object properties: name: type: string enum: - grep type: type: string enum: - grep enabled: anyOf: - type: boolean - type: 'null' permission_policy: anyOf: - $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' - type: 'null' required: - name additionalProperties: false - type: object properties: name: type: string enum: - read type: type: string enum: - read enabled: anyOf: - type: boolean - type: 'null' permission_policy: anyOf: - $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' - type: 'null' required: - name additionalProperties: false - type: object properties: name: type: string enum: - web_fetch type: type: string enum: - web_fetch enabled: anyOf: - type: boolean - type: 'null' permission_policy: anyOf: - $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' - type: 'null' allowed_domains: $ref: '#/components/schemas/Arrays_6' blocked_domains: $ref: '#/components/schemas/Arrays_6' max_content_tokens: anyOf: - type: integer exclusiveMinimum: 0 - type: 'null' required: - name additionalProperties: false - type: object properties: name: type: string enum: - web_search type: type: string enum: - web_search enabled: anyOf: - type: boolean - type: 'null' permission_policy: anyOf: - $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' - type: 'null' allowed_domains: $ref: '#/components/schemas/Arrays_6' blocked_domains: $ref: '#/components/schemas/Arrays_6' user_location: anyOf: - $ref: '#/components/schemas/Objects_11' - type: 'null' required: - name additionalProperties: false - type: object properties: name: type: string enum: - write type: type: string enum: - write enabled: anyOf: - type: boolean - type: 'null' permission_policy: anyOf: - $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' - type: 'null' required: - name additionalProperties: false Objects_12: type: object properties: enabled: anyOf: - type: boolean - type: 'null' permission_policy: anyOf: - $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' - type: 'null' additionalProperties: false MemoryProposalId: type: string pattern: ^mprop_[0-9a-f]{32}$ CurationRunId: type: string pattern: ^mcur_[0-9a-f]{32}$ Union_350: type: string enum: - ephemeral_zdr - bounded - durable Union_351: type: string enum: - none - allowlist - unrestricted ActionPolicyId: type: string pattern: ^apol_[0-9a-f]{32}$ Union_352: anyOf: - type: object properties: mode: type: string enum: - none allowed_hosts: $ref: '#/components/schemas/Arrays_50' required: - mode - allowed_hosts additionalProperties: false - type: object properties: mode: type: string enum: - unrestricted allowed_hosts: $ref: '#/components/schemas/Arrays_50' required: - mode - allowed_hosts additionalProperties: false - $ref: '#/components/schemas/SandboxAllowlistWithinHostLimit' ManagedAgentsIsoCountryCode: type: string pattern: ^[A-Z]{2}$ ManagedAgentsIanaTimeZone: type: string allOf: - minLength: 1 - maxLength: 255 ManagedAgentsCustomToolInputSchema: type: object properties: type: type: string enum: - object properties: anyOf: - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' - type: 'null' required: anyOf: - type: array items: type: string - type: 'null' required: - type additionalProperties: $ref: '#/components/schemas/JsonValue' description: JSON Schema for custom tool input parameters. ManagedToolId: type: string pattern: ^mtl_[0-9a-f]{32}$ ManagedToolReleaseId: type: string pattern: ^mtrel_[0-9a-f]{32}$ Arrays_50: type: array items: $ref: '#/components/schemas/SandboxAllowedHost' allOf: - maxItems: 0 SandboxAllowlistWithinHostLimit: type: object properties: mode: type: string enum: - allowlist allowed_hosts: type: array items: $ref: '#/components/schemas/SandboxAllowedHost' allOf: - maxItems: 256 required_egress_certification: type: string enum: - advisory_filter - security_boundary allow_package_managers: type: boolean allow_mcp_servers: type: boolean required: - mode - allowed_hosts additionalProperties: false JsonValue: description: >- A value in the JSON data model: null, boolean, finite number, string, array, or object. SandboxAllowedHost: type: string description: >- A lower-case public DNS hostname, never localhost or an IP literal, with an optional leading wildcard and TCP port from 1 through 65535. allOf: - maxLength: 261 - pattern: >- ^(?:\*\.)?[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)+(?::[1-9][0-9]{0,4})?$ securitySchemes: bearerAuth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.