Skip to main content

Abilities

Tags: abilities, automation, workflows

Endpoints

List

GET /api/v2/w/{workspace_uuid}/abilities

Description:

Workflow ability configuration and management

List configured ability instances for a workflow or task scope.

Exactly one of workflowId or taskId must be provided. When workflowId is given, only workflow-scoped abilities (task_id IS NULL) are returned; pass taskId for task-scoped ones.

Authorization: Requires agents:read scope

Parameters:

  • workflowId (Integer)
  • taskId (Integer)

Response: List of AbilityResponse


Create

POST /api/v2/w/{workspace_uuid}/abilities

Description:

Workflow ability configuration and management

Create (enable) a configured ability on a workflow or task scope.

Backs gr agents abilities enable. The request must name a workflowId (optionally with taskId) — abilities cannot be attached to an agent row directly.

Authorization: Requires agents:write scope

Parameters:

Response: See AbilityResponse


Types

GET /api/v2/w/{workspace_uuid}/abilities/types

Description:

Workflow ability configuration and management

List available ability types from the code registry.

Returns ability type definitions including slug, title, category, description, channels, flags, and config schema.

System abilities (auto-injected for core functionality) are hidden by default and surfaced only with includeSystem=true. Abilities gated behind workspace features are hidden when the feature is not enabled.

Authorization: Requires agents:read scope

Parameters:

  • includeSystem (Boolean)

Response: See AbilityTypesResponse


Types

GET /api/v2/w/{workspace_uuid}/abilities/types/{slug:path}

Description:

Workflow ability configuration and management

Return the full spec for a single ability type by slug.

Includes title, description, category, channels, singleton/system flags, required feature, and the JSON Schema of the params model. Backs gr abilities get --name X.

The :path converter lets the slug contain a colon (e.g. communication:phone_call_tools).

Authorization: Requires agents:read scope

Parameters:

  • slug (String)

Response: See AbilityTypeResponse


Delete Ability Uuid

DELETE /api/v2/w/{workspace_uuid}/abilities/{ability_uuid}

Description:

Workflow ability configuration and management

Delete a configured ability instance by UUID.

Backs the removal half of gr agents abilities management. Distinct from disable (which sets enabled=false but keeps the config).

Authorization: Requires agents:write scope

Parameters:

  • ability_uuid (String)

Response: See None


Update Ability Uuid

PATCH /api/v2/w/{workspace_uuid}/abilities/{ability_uuid}

Description:

Workflow ability configuration and management

Update a configured ability (configure / enable / disable).

Backs gr agents abilities configure (config + celCondition) and the enable/disable toggles (enabled). config is merged with the existing config; pass enabled to toggle activation.

Authorization: Requires agents:write scope

Parameters:

Response: See AbilityResponse