Tools API v1 documentation

Why This API Exists

Tools API v1 publishes JSON about salamyx.com tools and pages so scripts and assistants can link to the right URLs without scraping HTML.

• Get a consistent catalog of tools and short descriptions.
• Fetch per-page details (summary, privacy notes, limitations, FAQ).
• Build integrations in n8n, MCP wrappers, and internal scripts.

API Base URL

Use the production host and call endpoints under /api/v1.

https://salamyx.com/api/v1

Quick Start

Open these URLs in a browser or call them from scripts to see JSON responses immediately.

• https://salamyx.com/api/v1/health
• https://salamyx.com/api/v1/tools
• https://salamyx.com/api/v1/tools?id=sha256
• https://salamyx.com/api/v1/pages/sha256

Available Endpoints

Response Model

All endpoints return JSON with a top-level status field. Errors return failed with a message and proper HTTP status code.

{
  "status": "ok",
  "count": 2,
  "tools": [
    {
      "id": "sha256",
      "route": "/crypto/sha256/",
      "category": "crypto",
      "runtime": "browser",
      "riskLevel": "low"
    }
  ]
}

How To Use In Practice

• Use /api/v1/tools as the source catalog for automation and MCP wrappers.
• Use /api/v1/tools?id={toolId} when you need one specific tool record.
• Use /api/v1/pages/{pageId} when you need full metadata including FAQ, limitations, and privacy notes.
• Treat in-browser tools as client-side by default and add server-side execute endpoints only when technically required.

Request Examples

curl "https://salamyx.com/api/v1/tools?category=crypto"
curl "https://salamyx.com/api/v1/tools?id=sha256"
curl "https://salamyx.com/api/v1/pages/sha256"

n8n Example Flow

• Add an HTTP Request node.
• Set method to GET and URL to https://salamyx.com/api/v1/tools?category=crypto.
• Add an IF node to filter tools by riskLevel or status.
• Send results to Telegram, Slack, email, or another system.

FAQ