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 tohttps://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-Secretwhen verifying webhooks or issuing HMAC consent/receipt tokens without sending secrets inside URLs or persisting them. - RapidAPI / Zyla: Pass
X-RapidAPI-Keyor 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, andX-Tinplate-Prev-Receipt-Hashenforce strict format validation; browser endpoints (/free/*,/demo/*,/verify,/portal/*) enforce strictOriginchecks (403) andCache-Control: no-store; keylessPOST /mcpenforces a16 KBJSON-RPC pre-parse body cap and max2JSON-RPC items (1tools/callper request). - Fail-Closed SDK Guardrails & Redirect Protection: Both official SDKs (
@tinplate/sdkandtinplate) 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 onmadmaison/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
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"
}
}
}
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.