Get tool

Get a built-in tool’s parameters and outputs. An exact visible ID is retained; an unversioned name resolves to the newest visible family version. The returned id identifies that tool. Hidden or missing tools return 404. Requires workspace read access.

OAuth scope: api:read.

GET/api/v2/tools/{toolId}

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 GET "https://www.sim.ai/api/v2/tools/string?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "id": "slack_message",
    "name": "Slack Send Message",
    "description": "Send a message to a Slack channel.",
    "version": "1.0.0",
    "hostedApiKey": "none",
    "oauth": {
      "required": true,
      "provider": "slack",
      "requiredScopes": [
        "chat:write"
      ]
    },
    "params": {
      "channel": {
        "type": "string",
        "required": true,
        "description": "Channel ID to post into."
      },
      "text": {
        "type": "string",
        "required": true,
        "description": "Message body."
      }
    },
    "outputs": {
      "ts": {
        "type": "string",
        "description": "Message timestamp."
      }
    }
  }
}
{
  "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": "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

Query parameters

workspaceId*string

Workspace whose integration allowlist, revealed preview blocks, and deployed custom blocks decide what this catalog contains.

Length1 <= length <= 128

Response body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

GETGet blockGETList blocks