> ## Documentation Index > Fetch the complete documentation index at: https://checkfu.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Create a SurfaceScope > Maps a provider place — a root, team, channel, or DM — to one governed collaboration space under an installation. A `root` scope takes no `parent_id`, while `team`, `channel`, and `personal` each require an active parent in the same authorization scope and installation, and the hierarchy must stay acyclic. `(external_installation_id, external_id)` is unique, so re-registering the same provider place conflicts. Checkfu support posture: alpha; hosted. Required evidence journey: collaboration-identity. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities. ## OpenAPI ````yaml /openapi.json post /v1/surface-scopes openapi: 3.1.0 info: title: Checkfu API version: '2026-08-27' description: >- Authentication is declared per operation: API-key, runtime, or connector bearer; Automation signature; or credential-free pairing redemption. Every general Checkfu REST request requires the dated `Checkfu-Version` header (one of: 2026-08-27); the three MCP JSON-RPC transports use `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth callback carries neither Checkfu header. API keys resolve one Workspace without a request selector; authenticated responses identify it with `Checkfu-Workspace-Id`. servers: - url: https://api.checkfu.com security: - bearerAuth: [] tags: - name: organizations - name: sourceRepositories - name: tenants - name: workspaces - name: principals - name: principalGroups - name: principalAccessCredentials - name: apiKeys - name: agents - name: harnesses - name: harnessRuntime - name: sandboxProfiles - name: computerProfiles - name: permissionAssignments - name: actionPolicies - name: files - name: memoryStores - name: dreams - name: modelCredentials - name: modelRoutingProfiles - name: blueprintInstallations - name: toolSources - name: skills - name: skillSources - name: agentSources - name: skillProposals - name: instructionProposals - name: catalog - name: concepts - name: support - name: connections - name: connectionVaults - name: connectionAssignments - name: connectedRuntimes - name: projects - name: collaboration - name: automationGraphs - name: automations - name: actionApprovals - name: standingApprovals - name: usage - name: models - name: outcomes - name: budgets - name: billing - name: sessions - name: audit - name: sessionExports - name: runs - name: runnerPools - name: transcripts - name: sessionWatches - name: webhookEndpoints - name: integrationGateway - name: agentDeployments - name: workEnvironments - name: computers - name: computerScreens - name: computerBrowserObservations - name: computerBrowserActions - name: environments - name: vaults - name: apiMcp - name: a2a paths: /v1/surface-scopes: post: tags: - collaboration summary: Create a SurfaceScope description: >- Maps a provider place — a root, team, channel, or DM — to one governed collaboration space under an installation. A `root` scope takes no `parent_id`, while `team`, `channel`, and `personal` each require an active parent in the same authorization scope and installation, and the hierarchy must stay acyclic. `(external_installation_id, external_id)` is unique, so re-registering the same provider place conflicts. Checkfu support posture: alpha; hosted. Required evidence journey: collaboration-identity. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities. operationId: collaboration.createSurfaceScope parameters: - name: checkfu-version in: header schema: type: string enum: - '2026-08-27' required: true - name: idempotency-key in: header schema: type: string allOf: - maxLength: 255 required: false requestBody: content: application/json: schema: anyOf: - type: object properties: external_installation_id: $ref: '#/components/schemas/CollaborationInstallationId' external_id: type: string allOf: - minLength: 1 - maxLength: 512 visibility: $ref: '#/components/schemas/Union_182' membership: $ref: '#/components/schemas/Union_183' inheritance: $ref: '#/components/schemas/Union_184' display_name: type: string allOf: - minLength: 1 - maxLength: 512 - maxLength: 255 verified_member: false membership_assertion: false ambient_policy: $ref: '#/components/schemas/Objects_103' kind: type: string enum: - root parent_id: type: 'null' required: - external_installation_id - external_id - visibility - membership - inheritance - kind additionalProperties: false - type: object properties: external_installation_id: $ref: '#/components/schemas/CollaborationInstallationId' external_id: type: string allOf: - minLength: 1 - maxLength: 512 visibility: $ref: '#/components/schemas/Union_182' membership: $ref: '#/components/schemas/Union_183' inheritance: $ref: '#/components/schemas/Union_184' display_name: type: string allOf: - minLength: 1 - maxLength: 512 - maxLength: 255 verified_member: false membership_assertion: false ambient_policy: $ref: '#/components/schemas/Objects_103' kind: type: string enum: - team - channel - personal parent_id: $ref: '#/components/schemas/SurfaceScopeId' required: - external_installation_id - external_id - visibility - membership - inheritance - kind - parent_id additionalProperties: false required: true responses: '201': description: Success content: application/json: schema: anyOf: - $ref: '#/components/schemas/Objects_102' - $ref: '#/components/schemas/Objects_104' headers: checkfu-workspace-id: description: The Workspace resolved from the authenticated bearer credential. required: true schema: $ref: '#/components/schemas/WorkspaceId' '400': description: Typed Checkfu wire error content: application/json: schema: type: object required: - error properties: error: type: object properties: type: type: string enum: - validation.malformed message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#validation-malformed description: >- Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false additionalProperties: false '401': description: Typed Checkfu wire error content: application/json: schema: type: object required: - error properties: error: type: object required: - type - message - more properties: type: type: string enum: - auth.invalid_key message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-invalid-key description: >- Stable public documentation and remedy for this error type. additionalProperties: false additionalProperties: false '403': description: >- The organization, tenant, or workspace backing this key is administratively disabled. | Deployment governance or retention policy denied the request. content: application/json: schema: anyOf: - type: object required: - error properties: error: type: object properties: type: type: string enum: - auth.disabled_tenancy message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-disabled-tenancy description: >- Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false additionalProperties: false - $ref: '#/components/schemas/PolicyDeniedError' '404': description: >- The requested resource does not exist in the resolved deployment boundary. content: application/json: schema: $ref: '#/components/schemas/ValidationNotFoundError' '409': description: >- The request conflicts with the resource's current state. | An idempotent mutation conflicts with a completed or in-progress request for the same key. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ValidationConflictError' - $ref: '#/components/schemas/IdempotencyConflictError' '429': description: Typed Checkfu wire error headers: retry-after: description: >- Delay in seconds for rate limits or deployment quotas with a known release or UTC reset boundary required: false schema: type: integer minimum: 1 content: application/json: schema: type: object required: - error properties: error: type: object required: - type - message - more properties: type: type: string enum: - budget.exceeded message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#budget-exceeded description: >- Stable public documentation and remedy for this error type. additionalProperties: false additionalProperties: false '500': description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. content: application/json: schema: $ref: '#/components/schemas/RuntimeInternalError' security: - bearerAuth: [] components: schemas: CollaborationInstallationId: type: string allOf: - pattern: ^exti_[0-9a-f]{32}$ Union_182: type: string enum: - public - private - personal Union_183: type: string enum: - public - provider_members - personal Union_184: type: string enum: - inherit - isolate Objects_103: type: object properties: enabled: type: boolean muted: type: boolean max_responses_per_window: type: integer allOf: - minimum: 0 max_tokens_per_window: type: integer allOf: - minimum: 0 self_quiet_threshold: type: integer allOf: - minimum: 0 required: - enabled - muted - max_responses_per_window - max_tokens_per_window - self_quiet_threshold additionalProperties: false SurfaceScopeId: type: string allOf: - pattern: ^surf_[0-9a-f]{32}$ Objects_102: type: object properties: id: $ref: '#/components/schemas/SurfaceScopeId' workspace_id: $ref: '#/components/schemas/WorkspaceId' external_installation_id: $ref: '#/components/schemas/CollaborationInstallationId' external_id: type: string allOf: - minLength: 1 - maxLength: 512 visibility: $ref: '#/components/schemas/Union_182' membership: $ref: '#/components/schemas/Union_183' inheritance: $ref: '#/components/schemas/Union_184' display_name: anyOf: - type: string allOf: - minLength: 1 - maxLength: 512 - maxLength: 255 - type: 'null' state: $ref: '#/components/schemas/Union_185' verified_member: type: object properties: principal_id: $ref: '#/components/schemas/PrincipalId' external_identity_link_id: $ref: '#/components/schemas/ExternalIdentityLinkId' paired_at: type: string required: - principal_id - external_identity_link_id - paired_at additionalProperties: false membership_assertion: type: object properties: asserted_at: type: string freshness_horizon_seconds: type: integer allOf: - minimum: 60 - maximum: 86400 required: - asserted_at - freshness_horizon_seconds additionalProperties: false ambient_policy: $ref: '#/components/schemas/Objects_103' version: type: integer allOf: - exclusiveMinimum: 0 created_at: type: string updated_at: type: string kind: type: string enum: - root parent_id: type: 'null' required: - id - workspace_id - external_installation_id - external_id - visibility - membership - inheritance - display_name - state - version - created_at - updated_at - kind - parent_id additionalProperties: false Objects_104: type: object properties: id: $ref: '#/components/schemas/SurfaceScopeId' workspace_id: $ref: '#/components/schemas/WorkspaceId' external_installation_id: $ref: '#/components/schemas/CollaborationInstallationId' external_id: type: string allOf: - minLength: 1 - maxLength: 512 visibility: $ref: '#/components/schemas/Union_182' membership: $ref: '#/components/schemas/Union_183' inheritance: $ref: '#/components/schemas/Union_184' display_name: anyOf: - type: string allOf: - minLength: 1 - maxLength: 512 - maxLength: 255 - type: 'null' state: $ref: '#/components/schemas/Union_185' verified_member: type: object properties: principal_id: $ref: '#/components/schemas/PrincipalId' external_identity_link_id: $ref: '#/components/schemas/ExternalIdentityLinkId' paired_at: type: string required: - principal_id - external_identity_link_id - paired_at additionalProperties: false membership_assertion: type: object properties: asserted_at: type: string freshness_horizon_seconds: type: integer allOf: - minimum: 60 - maximum: 86400 required: - asserted_at - freshness_horizon_seconds additionalProperties: false ambient_policy: $ref: '#/components/schemas/Objects_103' version: type: integer allOf: - exclusiveMinimum: 0 created_at: type: string updated_at: type: string kind: type: string enum: - team - channel - personal parent_id: $ref: '#/components/schemas/SurfaceScopeId' required: - id - workspace_id - external_installation_id - external_id - visibility - membership - inheritance - display_name - state - version - created_at - updated_at - kind - parent_id additionalProperties: false WorkspaceId: type: string allOf: - pattern: ^wrkspc_[0-9a-f]{32}$ PolicyDeniedError: type: object properties: error: type: object properties: type: type: string enum: - policy.denied message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#policy-denied description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: Deployment governance or retention policy denied the request. ValidationNotFoundError: type: object properties: error: type: object properties: type: type: string enum: - validation.not_found message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#validation-not-found description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: >- The requested resource does not exist in the resolved deployment boundary. ValidationConflictError: type: object properties: error: type: object properties: type: type: string enum: - validation.conflict message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#validation-conflict description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: The request conflicts with the resource's current state. IdempotencyConflictError: anyOf: - $ref: '#/components/schemas/ValidationIdempotencyConflictError' - $ref: '#/components/schemas/ValidationIdempotencyInProgressError' description: >- An idempotent mutation conflicts with a completed or in-progress request for the same key. RuntimeInternalError: type: object properties: error: type: object properties: type: type: string enum: - runtime.internal message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#runtime-internal description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. Union_185: type: string enum: - active - disabled - disconnected - archived PrincipalId: type: string allOf: - pattern: ^prin_[0-9a-f]{32}$ ExternalIdentityLinkId: type: string allOf: - pattern: ^xid_[0-9a-f]{32}$ 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. securitySchemes: bearerAuth: type: http scheme: bearer ````