PUBLIC API REFERENCE / v1

Ship with a contract, not a guess.

A focused reference for the Swamix tool API. Find a tool, inspect its live input schema, and copy a server-side request in the language your stack already speaks.

30 documented tools POST JSON tool calls 3 ready-to-copy examples
POST

Auth whoami

Inspect the current authenticated identity

REQUEST

Endpoint and authentication

POSThttps://mcp.swamix.com/api/tools/call
AUTHBearer credential

Keep programmatic credentials in a server-side secret manager. Browser users authenticate with email sessions; this page never asks for a credential.

CONTENT TYPEapplication/json

Send the tool name and an arguments object. Unknown fields should be rejected before they reach production.

IDEMPOTENCYMedia operations

Reuse one operation key when retrying paid or asynchronous work after a timeout.

QUICK COPY

Call auth_whoami

curl -sS https://mcp.swamix.com/api/tools/call \
  -X POST \
  -H "Authorization: Bearer $SWAMIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "auth_whoami",
  "arguments": {}
}'

Set SWAMIX_API_KEY in the process environment. The examples contain placeholders only and never store or transmit a secret from this page.

INPUT SCHEMA

Arguments

No arguments required

Send an empty arguments object. The live schema will appear here when this tool publishes inputs.

RESPONSE

Read the result

Successful calls return a JSON envelope. Treat the result as tool-specific data and preserve the HTTP status when logging failures.

{
  "result": {
    "tool": "auth_whoami",
    "status": "success",
    "data": "tool-specific response"
  }
}
200 synchronous result202 asynchronous work may return a run handleJSON content type on success and error
ERRORS

Know what to do next

400
Invalid request

The tool name or arguments do not match the published schema.

401
Authentication required

Use a server-side programmatic credential or an authenticated email session.

402
Credits required

The account balance cannot cover this operation.

403
Forbidden

The account is not allowed to access this tool. Admin tools require admin access.

404
Not found

The route or tool name does not exist.

413
Payload too large

Reduce the request or use the supported asset flow.

429
Rate limited

Back off using response guidance; do not hot-loop retries.

5xx
Upstream failure

Retry safe work with bounded backoff and preserve idempotency for media.