Skip to main content

Interface: AbilityTypeResponse

Defined in: packages/sdk/src/types/generated/ability.ts:93

Response model for an ability type from the code registry.

Properties​

attachmentScopes?​

optional attachmentScopes: AbilityAttachmentScope[]

Defined in: packages/sdk/src/types/generated/ability.ts:104

Parent surfaces where new instances of this ability may be attached

category?​

optional category: string | null

Defined in: packages/sdk/src/types/generated/ability.ts:96

channels?​

optional channels: string[] | null

Defined in: packages/sdk/src/types/generated/ability.ts:112

Channels this ability is available on (sorted). null means all channels. Declarative introspection metadata, not an enforcement point — the ability's resolve() remains authoritative.

configSchema?​

optional configSchema: AbilityTypeResponseConfigSchema

Defined in: packages/sdk/src/types/generated/ability.ts:98

description?​

optional description: string | null

Defined in: packages/sdk/src/types/generated/ability.ts:97

requiredFeature?​

optional requiredFeature: string | null

Defined in: packages/sdk/src/types/generated/ability.ts:106

Workspace feature slug required for this ability to be available

requires?​

optional requires: AbilityRequirementResponse[]

Defined in: packages/sdk/src/types/generated/ability.ts:108

Effective workspace-resource requirements (GRA-6204), e.g. [{kind: 'feature', slug: 'gmail'}, {kind: 'connection', slug: 'gmail'}]. Includes requiredFeature adapted as a feature-kind entry. Enabling the ability with unmet connection requirements returns a correctible 400 unless allowMissingConnections is passed.

requiresChat?​

optional requiresChat: boolean

Defined in: packages/sdk/src/types/generated/ability.ts:110

If true, the ability only resolves inside a chat context

singleton?​

optional singleton: boolean

Defined in: packages/sdk/src/types/generated/ability.ts:100

If true, only one instance of this ability can exist per scope

slug​

slug: string

Defined in: packages/sdk/src/types/generated/ability.ts:94

system?​

optional system: boolean

Defined in: packages/sdk/src/types/generated/ability.ts:102

If true, this is an auto-injected system ability hidden from users

title​

title: string

Defined in: packages/sdk/src/types/generated/ability.ts:95