Support: support@tinplate.dev · Zero-Retention Edge Security Support Trust Center DPA GitHub Issues
API Reference & Contracts

Developer Documentation

All 42 Tinplate APIs share one uniform authentication scheme, JSON response envelope, error taxonomy, and OpenAPI 3.0.3 (per-API) / 3.1.0 (portfolio) contracts.

1. Base URL, Authentication & OWASP Edge Protections

Production requests are served globally from Cloudflare's edge network at https://api.tinplate.dev.

  • Direct Bearer Key (Zero-Proxy / All-Access Bundle): Pass Authorization: Bearer <API_KEY> directly to https://api.tinplate.dev. Recommended for security-sensitive production workloads because requests terminate directly at Tinplate's zero-logging Cloudflare Workers.
  • Ephemeral Signing Secrets: Pass X-Tinplate-Signing-Secret when verifying webhooks or issuing HMAC consent/receipt tokens without sending secrets inside URLs or persisting them.
  • RapidAPI / Zyla: Pass X-RapidAPI-Key or Zyla bearer key via marketplace gateway (proxy secrets are verified in constant time).
  • Request Security Controls: Failed Bearer attempts are brute-force throttled per salted IP hash (429 Retry-After: 60); X-Request-Id, X-Tinplate-Agent-Id, and X-Tinplate-Prev-Receipt-Hash enforce strict format validation; browser endpoints (/free/*, /demo/*, /verify, /portal/*) enforce strict Origin checks (403) and Cache-Control: no-store; keyless POST /mcp enforces a 16 KB JSON-RPC pre-parse body cap and max 2 JSON-RPC items (1 tools/call per request).
  • Fail-Closed SDK Guardrails & Redirect Protection: Both official SDKs (@tinplate/sdk and tinplate) block HTTP redirects by default (redirect: "error" / _NoRedirectHandler) and fail closed when guardrail steps error or return "block".
  • Support & Issue Tracker: Email support@tinplate.dev (Support) or file public issues on madmaison/tinplate-action/issues.

2. Standard Response & Error Envelope

Every endpoint returns HTTP 200 with ok: true on success, or a structured JSON error envelope with X-Request-Id and meta.ignored_fields when stripped unknown properties are detected:

Success Envelope (200 OK)

{
  "ok": true,
  "data": { ... },
  "meta": {
    "request_id": "2c8a9f10-91b4-4d3e-8a11-09ab12cd34ef",
    "ms": 1,
    "version": "1.0.39"
  }
}

Error Envelope (400 / 401 / 413 / 429 / 500)

{
  "ok": false,
  "error": {
    "code": "invalid_input",
    "message": "Invalid request payload"
  },
  "meta": {
    "request_id": "2c8a9f10-91b4-4d3e-8a11-09ab12cd34ef",
    "ms": 0,
    "version": "1.0.39"
  }
}

3. All 42 API Endpoints & OpenAPI 3.0.3 Specifications

API Name & GuidePrimary EndpointCategoryOpenAPI 3.0.3 Spec
PII Redactor API POST /v1/pii-redactor AI Safety & Agents pii-redactor.json
Prompt Injection Detection API POST /v1/prompt-guard AI Safety & Agents prompt-guard.json
MCP Server Manifest & Tool Security Linter API POST /v1/mcp-manifest-linter AI Safety & Agents mcp-manifest-linter.json
Agent Tool-Call Validator & Repairer API POST /v1/tool-call-validator AI Safety & Agents tool-call-validator.json
Deterministic Hallucination Diff API POST /v1/hallucination-diff AI Safety & Agents hallucination-diff.json
Prompt Cache Key & Context Budgeter API POST /v1/prompt-cache-budgeter AI Safety & Agents prompt-cache-budgeter.json
Agent Action Receipts API POST /v1/agent-action-receipts/issue AI Safety & Agents agent-action-receipts.json
Synthetic Content Provenance Checker API POST /v1/content-provenance AI Safety & Agents content-provenance.json
Broken JSON & LLM Output Healer API POST /v1/json-heal AI Data Prep json-heal.json
LLM HTML-to-Markdown Cleaner API POST /v1/html-to-markdown AI Data Prep html-to-markdown.json
Text-to-Structured Date, Money & Unit Parser API POST /v1/locale-value-parser AI Data Prep locale-value-parser.json
Log Redact & Secret Scanner API POST /v1/secret-scanner Security & Secrets secret-scanner.json
Agent URL & SSRF Firewall API POST /v1/ssrf-firewall Security & Secrets ssrf-firewall.json
HTTP Security Header Scanner API POST /v1/security-headers Security & Secrets security-headers.json
Webhook Signature Verifier API POST /v1/webhook-verify Security & Secrets webhook-verify.json
Email DNS Deliverability Auditor API POST /v1/email-dns Email & Domain email-dns.json
SPF, DKIM & DMARC Record Linter & Generator API POST /v1/email-dns-generator Email & Domain email-dns-generator.json
Stateless Consent & One-Click Unsubscribe Tokens API POST /v1/consent-tokens/issue Email & Domain consent-tokens.json
EU VAT & IBAN/BIC Validator API POST /v1/eu-vat-iban/iban Compliance & Business eu-vat-iban.json
Invoice & EU EN 16931 / Peppol Validator API POST /v1/invoice-validator Compliance & Business invoice-validator.json
Hungarian Business Document & NAV Validator API POST /v1/hu-business-validator Compliance & Business hu-business-validator.json
Workday & Holiday Calculator API POST /v1/workday-holiday/between Compliance & Business workday-holiday.json
Signup Fraud & Disposable Email Scorer API POST /v1/signup-fraud Compliance & Business signup-fraud.json
Cron & Schedule Explainer & Validator API POST /v1/cron-explainer Developer Utilities cron-explainer.json
OpenAPI & JSON Schema Breaking-Change Diff API POST /v1/schema-diff Developer Utilities schema-diff.json
User-Agent & AI Bot Parser API POST /v1/ua-bot-parser Developer Utilities ua-bot-parser.json
URL Normalizer & Tracking Parameter Stripper API POST /v1/url-normalizer Developer Utilities url-normalizer.json
ICS / iCalendar Feed Sanitizer & Validator API POST /v1/ics-sanitizer Developer Utilities ics-sanitizer.json
robots.txt & llms.txt AI Crawler Analyzer & Generator API POST /v1/robots-llms-analyzer Developer Utilities robots-llms-analyzer.json
SemVer & Package Manifest / Lockfile Diff Judge API POST /v1/semver-lockfile-judge Developer Utilities semver-lockfile-judge.json
LLM Output Safety, Leakage & Format Guardrail API POST /v1/llm-output-guard AI Safety & Agents llm-output-guard.json
Agent Shell Command & SQL Query Safety Firewall API POST /v1/command-sql-guard Security & Secrets command-sql-guard.json
European Corporate Tax, LEI, EORI & National ID Validator API POST /v1/eu-id-validator Compliance & Business eu-id-validator.json
JWT, JWS & JWK Security Auditor & RFC 8725 Linter API POST /v1/jwt-jwk-inspector Security & Secrets jwt-jwk-inspector.json
Markdown & Code Aware Smart RAG Document Chunker API POST /v1/rag-chunker Developer Utilities rag-chunker.json
Regex ReDoS Vulnerability Scanner & Pattern Explainer API POST /v1/regex-safety Developer Utilities regex-safety.json
LLM Chat Messages Policy Proxy & Sanitizer API POST /v1/llm-messages-guard AI Data Prep llm-messages-guard.json
Tabular CSV/JSON RAG Sanitizer & Formula-Injection Firewall API POST /v1/tabular-rag-cleaner AI Data Prep tabular-rag-cleaner.json
Peppol UBL 2.1 / XRechnung E-Invoice Converter & EPC-QR API POST /v1/peppol-ubl-invoice Compliance & Business peppol-ubl-invoice.json
EU Cross-Border VAT Rate & Reverse-Charge Calculator API POST /v1/eu-vat-calculator Compliance & Business eu-vat-calculator.json
Sanctions, Watchlist & Embargo Entity Screener API POST /v1/sanctions-screener Compliance & Business sanctions-screener.json
AI-Generated Code & CI Workflow Sandbox Auditor API POST /v1/agent-code-guard AI Data Prep agent-code-guard.json
Model Context Protocol (MCP 2025-03-26)

4. Official Streamable HTTP MCP Server (POST /mcp)

Connect Claude Desktop, Cursor, Windsurf, or OpenAI Agents SDK to expose all 49 endpoints across 42 APIs as MCP tools:

{
  "mcpServers": {
    "tinplate": {
      "type": "streamable-http",
      "url": "https://api.tinplate.dev/mcp"
    }
  }
}
Single-Request Chaining · Dynamic Step Piping

5. Multi-Step Composite Pipeline (POST /v1/pipeline) & Turnkey Presets (/v1/presets)

Execute up to 5 Tinplate endpoints sequentially in one Worker invocation with automatic short-circuiting (stop_on_block: true) and dynamic step piping via $steps.<stepId>.data.<field>:

curl -X POST "https://api.tinplate.dev/v1/pipeline?receipt=true" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "stop_on_block": true,
    "steps": [
      { "id": "guard", "endpoint": "/v1/prompt-guard", "body": { "text": "Contact alice@tinplate.dev", "context": "user_input" } },
      { "id": "redact", "endpoint": "/v1/pii-redactor", "body": { "text": "Contact alice@tinplate.dev", "locales": ["GLOBAL"], "mode": "token" } },
      { "id": "secrets", "endpoint": "/v1/secret-scanner", "body": { "text": "$steps.redact.data.redacted_text", "mode": "token" } }
    ]
  }'

Or call one of the 4 pre-wired Enterprise Presets (GET /v1/presets): llm-ingest-safe, llm-output-safe, agent-pre-exec, or eu-vendor-kyb. Append ?receipt=true for signed compliance receipts verifiable via /.well-known/jwks.json.