Run tool

Run a built-in tool using published parameter IDs. Requires workspace read access. Sim resolves credentialId, hosted keys, and whole-value {{VAR_NAME}} references in user-only parameters; other values pass through unchanged. Send connected credentials as top-level credentialId, not inside input. Third-party refusal returns 200 with status: "failed"; API failures use the error envelope. Hidden or missing tools return 404; disallowed integrations return 403 with error.details.code: INTEGRATION_NOT_ALLOWED. Hosted-key usage is billed to the workspace. A call that would use a hosted key returns 402 when the workspace exceeds usage or billing limits. 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

Request examples use an API key. For OAuth, replace the X-API-Key header with Authorization: Bearer YOUR_ACCESS_TOKEN.

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": "USAGE_LIMIT_EXCEEDED",
    "message": "Usage limit exceeded. Please upgrade your plan to continue."
  }
}
{
  "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"
  }
}

Path parameters

toolId*string

Tool identifier. An exact visible ID is retained; an unversioned name resolves to the newest visible family version. The response echoes the resolved ID.

Length1 <= length <= 255

Request body

application/json

Workspace, accepted tool arguments, and optional connected credential. Hidden fields and credential aliases inside input are rejected.

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

application/json

GETList billing logsGETGet block