Integrations

Execute an integration tool

Resolves the external tool name to its provider and vendor tool, then executes it against the caller's active connection. Identity is taken from the authenticated context only. request_id is ShanClaw's stable execution identity: replay does not repeat a completed vendor read or ledger write. Legacy call_id/X-Call-ID and then Idempotency-Key are fallback inputs.

post/api/v1/integrations/tools/{name}/execute

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/integrations/tools/{name}/execute
  • Auth: API key in header X-API-Key

Path parameters

namestring required

External integration tool name (from GET /api/v1/integrations/tools)

Request body

argumentsobject

Tool-specific parameters

call_idstring

Legacy stable idempotency key (also accepted as X-Call-ID)

request_idstring

Stable ShanClaw execution identity; preferred idempotency key

Response

Tool execution result (success may be false for a tool-level error)

errorstring nullable
metadataobject
outputunknown
successboolean
textstring nullable

Changes

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