Skip to content
← Changelog
2.2.116
Feature

Docs entry points for crawlers and agents

Starting today, the docs site has machine-readable entry points: robots.txt names the sitemap, pages carry canonical and Open Graph tags, and llms.txt links an OpenAPI file for the core endpoints.

A crawler or an agent no longer has to scrape the docs to find the API contract: two requests take it from the docs index to the OpenAPI file.

To start, run the two requests:

curl -s https://docs.apertis.ai/llms.txt | tail -n 3
curl -s https://apertis.ai/docs/openapi.yaml | head -n 4
Terminal output of the last lines of llms.txt, a Reference section that links the OpenAPI specification, followed by the first four lines of that YAML file

Find every entry point

Everything below is served from docs.apertis.ai unless noted.

URLContent typeHolds
/robots.txttext/plainAn allow-all rule and the sitemap location
/sitemap.xmlapplication/xmlThe canonical URL of every page, most with lastmod
/llms.txttext/plainAn index of the pages as Markdown links, plus the OpenAPI link
/llms-full.txttext/plainEvery page's Markdown in one file
/<page>.mdtext/markdownOne page as clean Markdown
/mcpJSON-RPC over POSTThe Docs MCP server (search_docs, get_page)
https://apertis.ai/docs/openapi.yamlapplication/yamlAn OpenAPI 3.0.3 file, on the main site host

Know what the OpenAPI file covers

The OpenAPI file declares the server https://api.apertis.ai/v1, API-key auth, and three operations: POST /chat/completions, GET /models and POST /embeddings. It does not describe the Responses, Messages, image, audio or billing endpoints; use the Markdown pages in llms.txt for those.

llms.txt follows the llmstxt.org layout: an H1, a one-paragraph summary, then H2 sections of - [Title](https://docs.apertis.ai/<path>.md): description entries. Each link is the page's clean Markdown. llms-full.txt holds the same pages in one file, with a Source: <canonical URL> line before each.

Crawl with robots.txt and the sitemap

User-agent: *
Allow: /

Sitemap: https://docs.apertis.ai/sitemap.xml

Every <loc> in the sitemap is the served form with a trailing slash, for example https://docs.apertis.ai/getting-started/quick-start/. The slash-less URL answers 308 to it. lastmod is the date of the last commit that touched the page's source, as ISO 8601 with offset (2026-10-06T14:59:11+08:00). The home page and /search/ carry no lastmod.

Read the canonical and Open Graph tags

Terminal output listing the canonical link and the og:url, og:title, og:type, og:site_name and twitter tags of the Quick Start page
TagValue on /getting-started/quick-start/
link rel="canonical"https://docs.apertis.ai/getting-started/quick-start/
og:urlthe same as canonical
og:titleQuick Start | Apertis Documentation
og:typearticle (website on non-article pages)
og:site_nameApertis Documentation
twitter:cardsummary

og:description is emitted only when the page defines a description; Quick Start has none. Documentation pages have no og:image. Each page also carries <meta name="apertis-docs:markdown" content="/getting-started/quick-start.md">, which points at its Markdown twin, and JSON-LD of type TechArticle and BreadcrumbList.

Choose between the files and the Docs MCP server

The MCP server at https://docs.apertis.ai/mcp accepts POST only (GET returns 405). It has two tools: search_docs (query, optional limit from 1 to 10, default 5) returns ranked pages with title, URL and snippet, and get_page (url) returns one page as Markdown. It reads the same llms.txt and llms-full.txt, so it serves the same pages, and it does not read the OpenAPI link. Use the files for crawling and bulk ingestion, and the MCP server for search at query time.