Developer Docs

Publish explainers without making your users read source code.

Everything you need to ship one explainer URL: the API reference, the shortest working upload flow, and agent integration notes for Claude Code, Cursor, Copilot, Codex, and similar tools.

API

Reference

Request format, response contract, upload safeguards, rate limits, and the validation path behind every published explainer.

  • Multipart upload request shape
  • Slug, expiry, and sanitization behavior
  • Error responses you should handle
Read the API reference
Getting Started

Quickstart

Go from API key to public URL in three steps, with a copy-pasteable curl request and the exact response payload your tool should expect.

  • Generate one HTML file
  • Upload with a bearer key
  • Return the public explainer URL
Open the quickstart
Agents

Integrations

Wire the existing explainer skill into AI coding agents, or call the API directly when your tool only needs an authenticated upload target.

  • Claude Code setup notes
  • Cursor, Copilot, and Codex guidance
  • When to use the skill vs direct API access
See integration guides

Fastest path to a working upload

If your tool already has HTML output, you can skip the skill entirely and call the upload API directly.

curl -X POST https://explainers.fyi/api/v1/upload \
  -H "Authorization: Bearer $EXPLAINERS_API_KEY" \
  -F "file=@./explainer.html;type=text/html" \
  -F "title=Auth flow overview" \
  -F "description=Explain the GitHub login pipeline" \
  -F "visibility=public"