Guide

Tools API v1 documentation

Use API v1 to list tools, fetch tool/page metadata, and integrate salamyx.com with automation systems or LLM orchestration.

  • Updated: 2026-04-30
  • API v1 serves metadata and catalog data. Browser-only tools continue to process user input locally on their dedicated pages.

API Base URL

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

https://salamyx.com/api/v1

Available Endpoints

GET /api/v1/health

API health check and version metadata.

GET /api/v1/tools

List tool catalog records. Supports query params: category, runtime, risk, q.

GET /api/v1/tools?id={toolId}

Get one tool record by id via query string.

GET /api/v1/pages/{pageId}

Get one canonical page payload by id.

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"
    }
  ]
}

Notes For Integrations

Privacy And Limitations

API v1 serves metadata and catalog data. Browser-only tools continue to process user input locally on their dedicated pages.

  • API v1 does not execute all tools server-side by default.
  • Compute endpoints for specific tools should be added only when server-side execution is required.
  • Future versions may introduce authentication and rate limits for production integrations.

Related Pages

FAQ

Does API v1 run all tools on the server?

No. The first version is metadata-first and exposes tool/page catalog data for integrations.

How can I list available tools?

Use GET /api/v1/tools and apply filters by category, runtime, risk, or search query.

How do I get one specific tool?

Use GET /api/v1/tools?id={toolId} with the tool id from the catalog response.

Can n8n and LLM agents use this API?

Yes. API v1 is designed for automation, MCP wrappers, and workflow systems.

Will there be per-tool execute endpoints?

Yes, but only for tools that need server-side processing, secrets, queues, or anti-abuse controls.