> ## 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. # Update a Session's title or metadata > Sets or clears a Session's display title and correlation metadata; title is required and null clears it, while metadata is optional — omitting it leaves… ## OpenAPI ````yaml /openapi.json post /v1/sessions/{session_id} 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/{session_id}: post: tags: - sessions summary: Update a Session's title or metadata description: >- Sets or clears a Session's display title and correlation metadata; `title` is required and `null` clears it, while `metadata` is optional — omitting it leaves the bag untouched and sending `{}` clears it. Metadata is replaced whole rather than merged per key, because the platform never reads the keys it stores. Both are display and correlation data only, with no admission, authorization, or routing meaning, and updating is last-write-wins and allowed while a turn is active or after the Session is terminal. A material change appends a content-free `session.title_updated` or `session.metadata_updated` marker — neither title text nor metadata keys and values enter the event ledger — while a non-null title or a non-empty bag is denied for zero-data-retention Sessions. Returns the updated Session. 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.patchSession parameters: - name: session_id in: path schema: $ref: '#/components/schemas/SessionId' required: true - name: checkfu-version in: header schema: type: string enum: - '2026-08-31' required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SessionUpdateParams' required: true responses: '200': description: ManagedAgentsSession content: application/json: schema: $ref: '#/components/schemas/ManagedAgentsSession_1' 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' '429': description: Typed Checkfu wire error headers: retry-after: description: >- Delay in seconds for rate limits or deployment quotas with a known release or UTC reset boundary required: false schema: type: integer minimum: 1 content: application/json: schema: type: object required: - error properties: error: type: object required: - type - message - more properties: type: type: string enum: - budget.exceeded message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#budget-exceeded description: >- Stable public documentation and remedy for this error type. additionalProperties: false additionalProperties: false '500': description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. content: application/json: schema: $ref: '#/components/schemas/RuntimeInternalError' security: - bearerAuth: [] components: schemas: SessionId: type: string pattern: ^sess_[0-9a-f]{32}$ SessionUpdateParams: type: object properties: agent: $ref: '#/components/schemas/ManagedAgentsSessionAgentUpdate' budget: anyOf: - $ref: '#/components/schemas/ManagedAgentsBudgetLimit' - type: 'null' metadata: anyOf: - $ref: '#/components/schemas/ResourceMetadataPatch' - type: 'null' title: anyOf: - type: string - type: 'null' vault_ids: type: array items: $ref: '#/components/schemas/VaultId' additionalProperties: false ManagedAgentsSession_1: 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. 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. 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. ManagedAgentsSessionAgentUpdate: type: object properties: mcp_servers: $ref: '#/components/schemas/Arrays_4' tools: $ref: '#/components/schemas/Arrays_5' additionalProperties: false 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 ResourceMetadataPatch: type: object additionalProperties: anyOf: - type: string allOf: - maxLength: 512 - type: 'null' allOf: - propertyNames: type: string allOf: - minLength: 1 - maxLength: 64 description: >- Metadata changes whose string values upsert and null values remove keys. VaultId: type: string pattern: ^vlt_[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' 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. EnvironmentId: type: string pattern: ^env_[0-9a-f]{32}$ 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 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}$ Arrays_4: type: array items: $ref: '#/components/schemas/Union_27' allOf: - maxItems: 20 Arrays_5: type: array items: $ref: '#/components/schemas/ManagedAgentsToolParams' allOf: - maxItems: 128 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, 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_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' 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' 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. 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 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. 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 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 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 ManagedAgentsComputerToolset: type: object properties: type: type: string enum: - computer_toolset_20260801 required: - type additionalProperties: false 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}$ 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 SessionResourceId: type: string pattern: ^sesrsc_[0-9a-f]{32}$ CurrentMountPath: type: string allOf: - minLength: 2 - maxLength: 1024 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 FileId: type: string pattern: ^file_[0-9a-f]{32}$ 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}$ ComputerId: type: string pattern: ^comp_[0-9a-f]{32}$ 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}$ ManagedAgentsIsoCountryCode: type: string pattern: ^[A-Z]{2}$ ManagedAgentsIanaTimeZone: type: string allOf: - minLength: 1 - maxLength: 255 MemoryProposalId: type: string pattern: ^mprop_[0-9a-f]{32}$ CurationRunId: type: string pattern: ^mcur_[0-9a-f]{32}$ 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.