Use these docs with LLMs and AI agents

Every page on this site is also plain Markdown, so a large language model (LLM) or an AI agent can read the same guides you do, without the site's layout around them. Point your assistant at one of the files below, and it can answer questions about Coritan and walk you through a task with the exact labels and API calls.

/docs/llms.txt

The index. It links every guide on this site, section by section, each with one line on what it covers, and names the files below. Give an agent this address first: it can then fetch only the pages it needs.

/docs/llms-full.txt

Every guide in one file, in the order the sidebar shows them. It is large (more than 2 MB), so use it with an assistant that can take a long context, or pick a section's file instead.

/docs/<section>/llms-full.txt

One section in one file, such as /docs/mail/llms-full.txt or /docs/billing/llms-full.txt. The section's slug is the part of its pages' addresses that follows /docs/.

/docs/api/llms-full.txt

The API guides and the whole generated API reference: every Client API and Organization API operation with its parameters, request body and answers. /docs/llms-full.txt leaves the reference out, because it is larger than every guide together.

<page>/index.md

Any single page as Markdown. Add index.md to the page's address: /docs/get-started/for-llms/index.md is this page.

/docs/search.json?q=

The site's search, as JSON. /docs/search.json?q=floating+ip answers {"query": ..., "results": [...]} with up to 12 results, each with its title, url, section, kind and a snippet.

Two routes of the Coritan API answer with guides as JSON. They suit a tool that knows which dashboard page someone is on. Neither needs a sign-in.

GET https://api.coritan.com/api/v1/help/pages?route=<path>

The guides for one dashboard page, most specific first, at most eight. On a resource's Overview, a path that ends in /overview, the area's tutorials come first. route is the page's path, such as /dashboard/deployments/1f2e3d4c/files, and must start with /. A guide counts when its routes name that page, or a page above it such as a server's files tab for a folder inside it. When no guide names the page or a page above it, pages is empty.

GET https://api.coritan.com/api/v1/help/search?q=<words>

A search of the guides, best match first, at most eight. Every word must match, and the last word also matches the start of a longer word, so a search works while someone types. It leaves out the operations of the API reference, which /search.json includes. An empty q answers an empty list.

Each guide in pages has its title, its description, its full address on this site in url, its page type, such as how-to, and the title of its section. docs_url is this site's home page, and a search also answers search_url, the same search on this site. The Help reference lists every field.

curl "https://api.coritan.com/api/v1/help/pages?route=/dashboard/deployments/1f2e3d4c/files"

{
  "route": "/dashboard/deployments/1f2e3d4c/files",
  "docs_url": "https://www.coritan.com/docs/",
  "pages": [
    {
      "title": "Manage server files",
      "description": "Browse, edit, upload, download, archive and extract your server's files in the dashboard file manager.",
      "url": "https://www.coritan.com/docs/managed-containers/files/",
      "type": "how-to",
      "section": "App Deployment"
    }
  ]
}

The example is shortened: this route also lists the SFTP guide and the overviews above it.

GET https://api.coritan.com/api/v1/help/changelog?limit=<number>

The newest changes from the changelog, newest first. limit sets how many, from 1 to 100, and is 20 when you leave it out. It needs no sign-in.

Each change has its date as YYYY-MM-DD, its title, the paragraph that describes it as plain text in summary, and in url its full address in the changelog, where it links the guide that covers it. docs_url is this site's home page and changelog_url is the changelog's first page. A limit below 1 or above 100 answers 422. The Help reference lists every field.

curl "https://api.coritan.com/api/v1/help/changelog?limit=1"

An agent that can browse

Such as a coding agent or an assistant with web access. Tell it to read https://www.coritan.com/docs/llms.txt and follow the links it needs.

A chat assistant without browsing

Download /docs/llms-full.txt, or one section's file, and attach it to the conversation.

Your own tool or retrieval index

Fetch /docs/llms.txt, then each page's index.md, and index those. The sitemap lists every page's address too.

The files change whenever the docs do, so fetch them again rather than keeping an old copy. Every change to Coritan that a customer could notice updates these docs at the same time.

Each page's Markdown starts with its title, its one-line summary and a Source: line with the page's address, then has the same steps, tables, examples and links as the page. Links to other pages are paths on www.coritan.com such as /docs/billing/add-credit/, with index.md added for the Markdown.

An assistant is only as right as what it reads. When an answer matters, such as a price, a limit or a step that deletes data, open the page it cites and check.

• Make your first API request
• API