Skip to content
Docs
hi-client.com (opens in a new tab)

Reading these docs from an agent

Download

How to get the hiClient documentation as Markdown with llms.txt, the .md suffix or the Accept header.

Every page of docs.hi-client.com also exists as plain Markdown, without menus or styles. It is the recommended way to give this documentation to an AI assistant.

llms.txt indexes

Address Content
https://docs.hi-client.com/llms.txt Index of every page, with title, description and a link to its Markdown.
https://docs.hi-client.com/llms.txt?lang=en Index of the pages in one language (?lang=es, ?lang=en or ?lang=pt).
https://docs.hi-client.com/llms-full.txt The whole documentation in a single text file.

Use the index when the agent can follow links and choose what to read. Use llms-full.txt when you prefer to hand it everything at once.

One page as Markdown

There are two ways to request a page as Markdown:

  1. Add .md to the end of the address.

    https://docs.hi-client.com/agents/permissions.md?lang=en
    
  2. Request the normal address with the Accept: text/markdown header.

    curl -H "Accept: text/markdown" https://docs.hi-client.com/agents/permissions?lang=en
    

The Markdown keeps the front matter (title, description) and the heading ids, so links to a section (#offers-read) keep working.

From the browser

Every page has two buttons:

  • Copy for agent: copies the page to the clipboard, ready to paste into a conversation.
  • Download: saves the guide as a Markdown file.

What to read first

For an agent that will operate an account, this order is enough:

  1. Conventions: pagination, revisions, errors and third-party text.
  2. Permissions: what each granted permission allows.
  3. Tools: the catalog by area.

Tip

Inside a connection, the account_whoami tool tells which permissions the agent has, what each area covers and what stays reserved to the portal. Call it first.