> ## 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. # Preview resolved Session setup > Read-only resolution of the exact Agent Version, Environment, model route and payer, and supported attachment access. ## OpenAPI ````yaml /openapi.json post /v1/sessions/preview 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: concepts - name: support - name: connections - name: connectionAssignments - name: connectedRuntimes - name: fileTrees - name: collaboration - name: automationGraphs - name: automations - name: actionApprovals - name: standingApprovals - name: workloadReviewPolicies - name: usage - name: models - 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: environments - name: vaults - name: apiMcp - name: a2a paths: /v1/sessions/preview: post: tags: - sessions summary: Preview resolved Session setup description: >- Read-only resolution of the exact Agent Version, Environment, model route and payer, and supported attachment access. Does not allocate execution, grant permissions, reserve credentials, or create Session state. Pass resolution_digest as expected_resolution on create to refuse setup drift. Repository preview is unavailable until its source resolver can run without credential publication. 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.previewSession parameters: - name: checkfu-version in: header schema: type: string enum: - '2026-08-31' required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SessionCreateParams' required: true responses: '200': description: Success content: application/json: schema: type: object properties: type: type: string enum: - session_preview resolution_digest: type: string pattern: ^sha256:[0-9a-f]{64}$ agent: $ref: '#/components/schemas/ManagedAgentsSessionAgent' environment: $ref: '#/components/schemas/Environment' model_routing: $ref: '#/components/schemas/SessionModelRoutingAccessCoverage' resources: $ref: '#/components/schemas/ManagedAgentsSessionResources' required: - type - resolution_digest - agent - environment - resources 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: $ref: '#/components/schemas/ValidationMalformedError' '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. | The operation is illegal for the resource's current lifecycle state. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ValidationConflictError' - $ref: '#/components/schemas/RuntimeInvalidTransitionError' '422': description: >- The harness does not satisfy the required protocol or capability set. content: application/json: schema: $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. | Platform-managed model credentials are temporarily unavailable. content: application/json: schema: anyOf: - $ref: '#/components/schemas/AuthorizationUnavailableError' - $ref: '#/components/schemas/ModelPlatformSupplyUnavailableError' security: - bearerAuth: [] components: schemas: SessionCreateParams: type: object properties: expected_resolution: type: string pattern: ^sha256:[0-9a-f]{64}$ agent: $ref: '#/components/schemas/ManagedAgentsSessionAgentParams' environment_id: $ref: '#/components/schemas/EnvironmentId' model_routing: type: object properties: type: type: string enum: - profile id: $ref: '#/components/schemas/ModelRoutingProfileId' version: type: integer exclusiveMinimum: 0 required: - type - id - version additionalProperties: false 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_340' 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_341' 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' acted_as: $ref: '#/components/schemas/PrincipalId' required: - agent - environment_id additionalProperties: false 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' 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 Environment: type: object properties: id: $ref: '#/components/schemas/EnvironmentId' archived_at: anyOf: - type: string - type: 'null' config: $ref: '#/components/schemas/EnvironmentConfig' created_at: type: string description: anyOf: - type: string - type: 'null' metadata: $ref: '#/components/schemas/ResourceMetadata' name: type: string type: type: string enum: - environment updated_at: type: string scope: $ref: '#/components/schemas/EnvironmentScope' required: - id - archived_at - config - created_at - description - metadata - name - type - updated_at additionalProperties: false SessionModelRoutingAccessCoverage: type: object properties: original_published_profile: type: object properties: id: $ref: '#/components/schemas/ModelRoutingProfileId' version_id: $ref: '#/components/schemas/ModelRoutingProfileVersionId' version: type: integer exclusiveMinimum: 0 content_sha256: type: string pattern: ^sha256:[0-9a-f]{64}$ required: - id - version_id - version - content_sha256 additionalProperties: false routing_policy: $ref: '#/components/schemas/Union_127' eligible_candidates: type: array prefixItems: - $ref: '#/components/schemas/Objects_196' minItems: 1 items: $ref: '#/components/schemas/Objects_196' access_intents: type: array prefixItems: - $ref: '#/components/schemas/Union_320' minItems: 1 items: $ref: '#/components/schemas/Union_320' required: - routing_policy - eligible_candidates - access_intents additionalProperties: false ManagedAgentsSessionResources: type: array items: $ref: '#/components/schemas/ManagedAgentsSessionResourceParams' 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. 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. 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. 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. 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. ManagedAgentsSessionAgentParams: anyOf: - $ref: '#/components/schemas/AgentId' - $ref: '#/components/schemas/ManagedAgentsAgentParams' - $ref: '#/components/schemas/ManagedAgentsAgentWithOverridesParams' EnvironmentId: type: string pattern: ^env_[0-9a-f]{32}$ ModelRoutingProfileId: type: string pattern: ^mrp_[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: $ref: '#/components/schemas/ManagedAgentsUserMessageEventParams' 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 VaultId: type: string pattern: ^vlt_[0-9a-f]{32}$ Union_340: type: string enum: - none - digests - content Union_341: 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. PrincipalId: type: string pattern: ^prin_[0-9a-f]{32}$ AgentId: type: string pattern: ^agent_[0-9a-f]{32}$ 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, codex, deepseek, 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' 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 EnvironmentConfig: anyOf: - $ref: '#/components/schemas/CloudConfig' - $ref: '#/components/schemas/SelfHostedConfig' EnvironmentScope: type: string enum: - organization - account ModelRoutingProfileVersionId: type: string pattern: ^mrprev_[0-9a-f]{32}$ Union_127: type: string enum: - cheapest_sufficient - pinned - fallback Objects_196: type: object properties: tier: type: string enum: - default provider: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ model: type: string allOf: - minLength: 1 context_window_tokens: type: integer exclusiveMinimum: 0 effort: type: string enum: - low - medium - high - xhigh - max speed: type: string enum: - standard - fast inference_geo: $ref: '#/components/schemas/Union_11' openrouter_max_price: $ref: '#/components/schemas/OpenRouterMaxPrice' native_capabilities: anyOf: - type: object properties: version: type: number enum: - 1 wire_format: type: string enum: - openai_chat max_output_tokens: type: integer exclusiveMinimum: 0 input_modalities: type: array prefixItems: - type: string enum: - text - image minItems: 1 items: type: string enum: - text - image reasoning: type: boolean thinking_levels: $ref: '#/components/schemas/Objects_70' compatibility: type: object properties: supportsStore: type: boolean supportsDeveloperRole: type: boolean supportsReasoningEffort: type: boolean supportsUsageInStreaming: type: boolean supportsFinishReason: type: boolean maxTokensField: type: string enum: - max_tokens - max_completion_tokens requiresToolResultName: type: boolean requiresAssistantAfterToolResult: type: boolean requiresThinkingAsText: type: boolean requiresReasoningContentOnAssistantMessages: type: boolean thinkingFormat: type: string enum: - openai - openrouter - deepseek - together - zai - qwen - string-thinking - ant-ling zaiToolStream: type: boolean supportsStrictMode: type: boolean supportsOpenAIGrammarTools: type: boolean supportsMidConvoSystemMessages: type: boolean supportsMidConvoToolAdditions: type: boolean supportsThinkingTokenBudget: type: boolean thinkingTokenBudgetField: type: string enum: - thinking_token_budget - thinking_budget - thinking_budget_tokens required: - supportsStore - supportsDeveloperRole - supportsReasoningEffort - supportsUsageInStreaming - supportsFinishReason - maxTokensField - requiresToolResultName - requiresAssistantAfterToolResult - requiresThinkingAsText - requiresReasoningContentOnAssistantMessages - thinkingFormat - zaiToolStream - supportsStrictMode - supportsOpenAIGrammarTools - supportsMidConvoSystemMessages - supportsMidConvoToolAdditions - supportsThinkingTokenBudget additionalProperties: false required: - version - wire_format - max_output_tokens - input_modalities - reasoning - thinking_levels - compatibility additionalProperties: false - type: object properties: version: type: number enum: - 1 wire_format: type: string enum: - openai_responses max_output_tokens: type: integer exclusiveMinimum: 0 input_modalities: type: array prefixItems: - type: string enum: - text - image minItems: 1 items: type: string enum: - text - image reasoning: type: boolean thinking_levels: $ref: '#/components/schemas/Objects_70' compatibility: type: object properties: supportsDeveloperRole: type: boolean supportsMidConvoSystemMessages: type: boolean supportsStrictMode: type: boolean supportsOpenAIGrammarTools: type: boolean supportsAdditionalTools: type: boolean supportsToolSearch: type: boolean supportsExplicitPromptCacheMode: type: boolean supportsMaxOutputTokens: type: boolean required: - supportsDeveloperRole - supportsMidConvoSystemMessages - supportsStrictMode - supportsOpenAIGrammarTools - supportsAdditionalTools - supportsToolSearch - supportsExplicitPromptCacheMode - supportsMaxOutputTokens additionalProperties: false required: - version - wire_format - max_output_tokens - input_modalities - reasoning - thinking_levels - compatibility additionalProperties: false - type: object properties: version: type: number enum: - 1 wire_format: type: string enum: - anthropic_messages max_output_tokens: type: integer exclusiveMinimum: 0 input_modalities: type: array prefixItems: - type: string enum: - text - image minItems: 1 items: type: string enum: - text - image reasoning: type: boolean thinking_levels: $ref: '#/components/schemas/Objects_70' compatibility: type: object properties: supportsEagerToolInputStreaming: type: boolean supportsCacheControlOnTools: type: boolean supportsTemperature: type: boolean forceAdaptiveThinking: type: boolean allowEmptySignature: type: boolean supportsStrictTools: type: boolean supportsMidConvoEffort: type: boolean supportsMidConvoSystemMessages: type: boolean supportsMidConvoToolChanges: type: boolean required: - supportsEagerToolInputStreaming - supportsCacheControlOnTools - supportsTemperature - forceAdaptiveThinking - allowEmptySignature - supportsStrictTools - supportsMidConvoEffort - supportsMidConvoSystemMessages - supportsMidConvoToolChanges additionalProperties: false required: - version - wire_format - max_output_tokens - input_modalities - reasoning - thinking_levels - compatibility additionalProperties: false native_sdk_estimation: $ref: '#/components/schemas/Objects_71' required: - tier - provider - model additionalProperties: false Union_320: anyOf: - type: object properties: kind: type: string enum: - platform_supply provider: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ required: - kind - provider additionalProperties: false - type: object properties: kind: type: string enum: - workspace_credential provider: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ model_credential_id: $ref: '#/components/schemas/ModelCredentialId' model_credential_generation_id: $ref: '#/components/schemas/ModelCredentialGenerationId' api_format: $ref: '#/components/schemas/ModelApiFormat' base_url: anyOf: - $ref: '#/components/schemas/PublicModelBaseUrl' - type: 'null' credential_resource_version: type: integer exclusiveMinimum: 0 required: - kind - provider - model_credential_id - model_credential_generation_id additionalProperties: false ManagedAgentsSessionResourceParams: anyOf: - $ref: '#/components/schemas/ManagedAgentsGitHubRepositoryResourceParams' - $ref: '#/components/schemas/ManagedAgentsFileResourceParams' - $ref: '#/components/schemas/ManagedAgentsMemoryStoreResourceParam' 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 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. 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: - type: object properties: type: type: string enum: - agent_toolset_20260401 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_14' required: - type - configs - default_config 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 enabled: type: boolean permission_policy: $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' required: - name - enabled - permission_policy additionalProperties: false default_config: $ref: '#/components/schemas/Objects_14' required: - type - mcp_server_name - configs - default_config additionalProperties: false - $ref: '#/components/schemas/Objects_13' CloudConfig: type: object properties: type: type: string enum: - cloud networking: anyOf: - $ref: '#/components/schemas/UnrestrictedNetwork' - $ref: '#/components/schemas/LimitedNetwork' packages: $ref: '#/components/schemas/Packages' required: - type - networking - packages additionalProperties: false SelfHostedConfig: type: object properties: type: type: string enum: - self_hosted networking: anyOf: - $ref: '#/components/schemas/UnrestrictedNetwork' - $ref: '#/components/schemas/LimitedNetwork' required: - type additionalProperties: false Union_11: type: string enum: - global - us OpenRouterMaxPrice: type: object properties: prompt: type: number allOf: - minimum: 0 - maximum: 1000 completion: type: number allOf: - minimum: 0 - maximum: 1000 required: - prompt - completion additionalProperties: false description: >- maximum OpenRouter prompt and completion prices in USD per million tokens Objects_70: type: object properties: 'off': $ref: '#/components/schemas/Union_131' minimal: $ref: '#/components/schemas/Union_131' low: $ref: '#/components/schemas/Union_131' medium: $ref: '#/components/schemas/Union_131' high: $ref: '#/components/schemas/Union_131' xhigh: $ref: '#/components/schemas/Union_131' max: $ref: '#/components/schemas/Union_131' required: - 'off' - minimal - low - medium - high - xhigh - max additionalProperties: false Objects_71: type: object properties: version: type: number enum: - 1 unit: type: string enum: - usd_per_million_tokens source: type: string enum: - profile_declared input: type: number minimum: 0 output: type: number minimum: 0 cache_read: type: number minimum: 0 cache_write: type: number minimum: 0 required: - version - unit - source - input - output - cache_read - cache_write additionalProperties: false ModelCredentialGenerationId: type: string pattern: ^mcgen_[0-9a-f]{32}$ 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 PublicModelBaseUrl: type: string allOf: - maxLength: 2048 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_118' required: - kind - ref additionalProperties: false - type: object properties: kind: type: string enum: - version version: $ref: '#/components/schemas/Union_112' 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 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 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}$ 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: - auto required: - type additionalProperties: false - 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_14: type: object properties: enabled: type: boolean permission_policy: $ref: '#/components/schemas/ManagedAgentsPermissionPolicy' required: - enabled - permission_policy 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 UnrestrictedNetwork: type: object properties: type: type: string enum: - unrestricted required: - type additionalProperties: false LimitedNetwork: type: object properties: type: type: string enum: - limited allow_mcp_servers: type: boolean allow_package_managers: type: boolean allowed_hosts: type: array items: type: string required: - type - allow_mcp_servers - allow_package_managers - allowed_hosts additionalProperties: false Packages: type: object properties: type: type: string enum: - packages apt: $ref: '#/components/schemas/Arrays_46' cargo: $ref: '#/components/schemas/Arrays_46' gem: $ref: '#/components/schemas/Arrays_46' go: $ref: '#/components/schemas/Arrays_46' npm: $ref: '#/components/schemas/Arrays_46' pip: $ref: '#/components/schemas/Arrays_46' required: - apt - cargo - gem - go - npm - pip additionalProperties: false Union_131: anyOf: - type: string allOf: - minLength: 1 - maxLength: 255 - type: 'null' 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 FileId: type: string pattern: ^file_[0-9a-f]{32}$ ManagedAgentsFileResourceMountPath: type: string allOf: - minLength: 2 - maxLength: 1024 MemoryStoreId: type: string pattern: ^memstore_[0-9a-f]{32}$ Union_118: 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 Union_112: anyOf: - $ref: '#/components/schemas/MemoryVersionId' - $ref: '#/components/schemas/MemorySnapshotId' 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 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' 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: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' required: type: array items: type: string required: - type additionalProperties: $ref: '#/components/schemas/JsonValue' description: JSON Schema for custom tool input parameters. Arrays_46: type: array items: type: string SessionId: type: string pattern: ^sess_[0-9a-f]{32}$ MemoryProposalId: type: string pattern: ^mprop_[0-9a-f]{32}$ CurationRunId: type: string pattern: ^mcur_[0-9a-f]{32}$ MemoryVersionId: type: string pattern: ^memver_[0-9a-f]{32}$ MemorySnapshotId: type: string pattern: ^memsnap_[0-9a-f]{32}$ 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 JsonValue: description: >- A value in the JSON data model: null, boolean, finite number, string, array, or object. securitySchemes: bearerAuth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.