Headoni

For LLMs & agents

Every Headoni doc ships a plain-text, machine-readable twin. Start from the index at /llms.txt and an agent can recursively reach every page through the /llms endpoints alone.

For LLMs & agents

Every documentation page on this site ships an LLM twin: a plain-text markdown copy of the same page, built for machines. The twin has the same facts as the human page with the styling stripped out: flat headings, short sentences, every field spelled out with its type and constraints, full request examples, and every error code. Point a model or a coding agent at one and it can integrate the Headoni API without scraping the rendered site.

Start at the index

https://docs.headoni.com/llms.txt is the machine index. It lists every documentation page with a link to its plain-text version, so an agent can fetch this one URL and then recursively reach every page without leaving the /llms endpoints. If you would rather have everything in a single fetch, https://docs.headoni.com/llms-full.txt is the whole corpus concatenated.

curl
# The index of every page
curl https://docs.headoni.com/llms.txt
 
# One page, as plain text
curl https://docs.headoni.com/llms/api/create-ticket
 
# Everything in one file
curl https://docs.headoni.com/llms-full.txt

Two ways to reach a twin

  1. The "LLM doc" button at the bottom of any API page opens that page's plain-text twin in a new tab.
  2. Swap /docs for /llms in any page URL. The human page https://docs.headoni.com/docs/api/create-ticket has the twin https://docs.headoni.com/llms/api/create-ticket.

Not the same as a desk's own llms.txt

This site documents the Headoni API in general. Separately, every live desk publishes its own https://<your-desk>.headoni.app/llms.txt: the same reference, pre-filled with that desk's departments, ticket types, and defaults. Use the docs-site index here to learn the API; hand an agent the desk's own URL when you want it to file tickets against a specific desk without copy-pasting ids.

LLM doc