Run Tool

Run a built-in tool using published parameter IDs. Sim resolves credentialId, hosted keys, and whole-value {{VAR_NAME}} references for user-only parameters; other values pass through verbatim. Third-party refusal returns 200 with status: "failed"; the error envelope covers API failures. Hidden or missing tools return 404; disallowed integrations return 403 with error.details.code: INTEGRATION_NOT_ALLOWED. Hosted-key use is billed to the workspace. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:write.

POST/api/v2/tools/{toolId}/execute

Authorization

X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Path Parameters

toolId*string

Tool identifier. An unversioned name resolves to the newest version, and the response echoes the resolved id.

Length1 <= length <= 255

Request Body

application/json

Workspace, arguments, and the credential to authenticate with.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://www.sim.ai/api/v2/tools/string/execute" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "input": {      "channel": "C0123456789",      "text": "Deploy finished."    },    "credentialId": "cred_01J8ZK3QW4M6X2R9T7B5C0V2"  }'
{
  "data": {
    "toolId": "slack_message",
    "status": "succeeded",
    "output": {
      "ts": "1718191234.004500"
    },
    "error": null
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Request body must be sent as application/json"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}
GETList Billing LogsGETGet Block