Quickstart

From HTML file to public explainer URL in one request.

The free tier is intentionally simple: create a dashboard key, upload a single HTML file to /api/v1/upload, and store the returned url for sharing.

01

Create an API key

Generate a dashboard key once and keep the plaintext value somewhere safe. The service only shows the full key at creation time.

02

Upload one HTML file

Send your generated explainer as multipart form data. Optional title, description, tags, and Pro-only visibility fields control metadata and sharing.

03

Use the returned URL

The API responds with a permanent slug, visibility, and the active retention policy. Free-tier explainers stay live for 30 days; Pro explainers return expires_at: null.

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"