Capability Plane

Execute one unified capability

Executes a capability. If its catalog entry has approval_required=True and no approved plan_id is supplied, this does NOT execute -- it returns a pending plan (status='approval_required' on the receipt, plus plan_id/plan_hash/nonce) instead. Approve it via POST /v1/capability-executions/{plan_id}/approve, then call this endpoint again with plan_id set to actually run it.

post/v1/capabilities/execute

Request

  • Base URL: https://api.algenta.ai
  • URL: https://api.algenta.ai/v1/capabilities/execute
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

capability_idstring required
binding_idstring nullable
inputobject nullable
request_idstring nullable
plan_idstring nullable

Reference to a previously proposed capability execution plan (returned as plan_id when an approval_required capability was invoked without a prior approval). Required to actually execute such a capability once its plan has been approved via POST /v1/capability-executions/{plan_id}/approve. Ignored (must be omitted) for capabilities that do not require approval.

Response

Successful Response

execution_session_idstring required
capability_idstring required
provider_idstring required
binding_idstring required
execution_owner'algenta_managed' | 'client_managed' required
status'started' | 'succeeded' | 'failed' required
outputobject nullable
errorobject nullable
started_atstring date-time required
completed_atstring date-time nullable
plan_idstring nullable

Set when this capability is approval_required: identifies the pending or decided execution plan.

plan_hashstring nullable

Hash of the proposed plan; an approval is bound to this.

noncestring nullable

Single-use approval challenge -- present only when a new plan is proposed.

receiptobject nullable

The versioned ExecutionReceipt (apps.api_server.schemas.receipt), present once a plan is proposed (status='approval_required') or actually executed (status='executed'/'failed').

Changes

No recorded changes to this operation across all 1 revision of this API.