For LLMs & agents
Hep.gg publishes plain-text, machine-readable API references at /llms.txt and /llms/<app>.txt, built for LLMs, coding agents, and RAG indexers.
For LLMs & agents
Alongside these human docs, Hep.gg publishes a set of plain-text, machine-readable API references built for large language models, coding agents, and retrieval pipelines. They cover the same APIs documented here, but dense and stripped of styling: short prose, tight endpoint listings, example payloads, and error codes. Point a model or an agent at them and it can integrate a Hep.gg app without scraping the rendered site.
Start here
https://hep.gg/llms.txt is the index: it lists every per-app file and the conventions shared across them. Fetch it first, then pull whichever app file you need.
# The index of every machine-readable doc
curl https://hep.gg/llms.txt
# A single app reference
curl https://hep.gg/llms/database.txtconst index = await (await fetch("https://hep.gg/llms.txt")).text();
const databaseDoc = await (await fetch("https://hep.gg/llms/database.txt")).text();
// Feed either straight into your model's context.The directory
Every app reference is one text/plain file at https://hep.gg/llms/<app>.txt.
| App | Reference | What it covers |
|---|---|---|
| Uploader | uploader.txt | ShareX-style file uploads and the /:id file serve. |
| URL Shortener | shorten.txt | Creating shortlinks. |
| SMS | sms.txt | Sending outbound SMS at sms.hep.gg. |
| email.txt | The transactional email send API. | |
| Music | music.txt | Download, search, and stream tracks. |
| ID Generator | idgen.txt | Generating UUIDs, nanoids, snowflakes, and more. |
| AI Gateway | ai.txt | The Anthropic-compatible AI proxy. |
| Cloud Storage | storage.txt | S3-compatible object storage. |
| Database | database.txt | Provisioning and managing databases with a bearer key. |
| Forms | forms.txt | The public form-fetch and submission API. |
| Snippets | snippets.txt | Creating pastes (CLI / ShareX) and reading them raw. |
| Profiles | profiles.txt | The public profile, presence, and contact endpoints. |
| Login (OIDC) | login.txt | Sign in with Hep.gg: the full OAuth2 / OIDC flow. |
Conventions
Every reference follows the same rules, so a model only has to learn them once:
- Base URL is
https://hep.ggunless the file names a per-app host (for examplesms.hep.gg,music.jakeypri.me,paste.hep.gg). - Auth is per-app and stated at the top of each file: a bearer key, an API key, or OAuth tokens. Cookie-authenticated endpoints exist for the dashboard and are listed only for completeness, marked as not for programmatic use.
- Responses are JSON envelopes:
{ "ok": true, "data": ... }on success and{ "ok": false, "error": "<message>", "code"?: "<token>" }on failure. A few legacy endpoints predate the envelope and say so. - Timestamps are ISO 8601 UTC.
- Rate limits, where present, are documented per endpoint and return HTTP
429withRetry-After.
The files are cached for a few minutes and are safe for crawlers and RAG indexers to fetch on a schedule.