Как мы упростили API-документацию корпоративного мессенджера Пачка для ИИ
Оглавление
В этой статье покажем, как новый стандарт llms.txt сделал нашу API‑документацию удобной для нейросетей и как вы сможете сделать то же самое.
Сегодня компании часто используют ИИ-агентов и языковые модели, такие как ChatGPT, DeepSeek, Claude, Gemini или Cursor для автоматизации рабочих задач. Но чтобы такие агенты действительно работали, им нужен простой и понятный источник знаний — не лендинг с кнопками и баннерами, а четкая структура и чистые данные. Поэтому формат Markdown и стандарт llms.txt быстро становятся новой нормой: они делают документацию читаемой для ИИ.
Недавно мы тоже внедрили поддержку нового стандарта llms.txt в нашу документацию и хотим рассказать, как это может быть полезно вам ;)
Почему llms.txt становится новым стандартом
llms.txt — это простой Markdown файл на сайте по адресу /llms.txt. Он представляет собой сводку самого важного контента документации, структурированный так, чтобы ИИ легко его читал — без беспорядка HTML, Javascript и рекламы.
Когда пользователь спрашивает ИИ «Как начать работу с сервисом X?», модели нужен быстрый доступ к точному ответу. Если передавать ИИ обычную ссылку на документацию, модели приходится загружать громоздкий исходный код, очищать его от мусора, выделяя важный текст, и тратить лишние токены на разбор — ответы становятся еще дороже, медленнее и менее точными. А вот llms.txt решает проблему, так как не содержит этой лишней информации.
В отличие от привычных служебных файлов сайта, считываемых поисковиками — таких как robots.txt, который лишь указывает, что не индексировать, или sitemap.xml, который просто перечисляет URL-адреса страниц, — llms.txt предназначен именно для ИИ и содержит структурированное, осмысленное представление о контенте.
Пример llms.txt файла:
Что мы сделали в Пачке для удобства работы с ИИ
Теперь в API-документации Пачки на всех страницах есть кнопка «Скопировать как .md». А можно сразу просмотреть каждый метод в этом формате, добавив к URL страницы окончание .md.
Также мы добавили специальные файлы:
- https://crm.pachca.com/dev/llms.txt — краткая версия всей документации в Markdown
- https://crm.pachca.com/dev/llms-full.txt — полная версия в едином файле с оглавлением
Как начать использовать новые возможности
Начать пользоваться новой документацией просто. Если ваш ИИ-агент поддерживает веб‑браузинг (обработку веб‑контента в реальном времени), отправьте ему ссылку на /llms.txt или /llms-full.txt. Если нет — просто вставьте их текст или приложите файлом. Этого достаточно, чтобы агент обучился на всей API-документации Пачки!
С использованием ИИ-агентов, обученных на этих файлах, даже без сильных технических навыков можно создавать API-автоматизации и различные скрипты под свои сценарии. ИИ-агенты и ассистенты помогут быстро создавать ботов для использования Webhooks, интегрировать чаты с внешними сервисами и автоматизировать подсчет аналитики. Главное — понятно изложить идею автоматизации и загрузить Markdown-версию (или ссылку на нее) в чат с ИИ-агентом.
Мы сами таким активно пользуемся! Например, недавно нам нужно было упростить работу поддержки: раньше при вопросах пользователей по API приходилось обращаться к разработчикам, а теперь поддержка задает вопрос ИИ-агенту и, если он релевантный, то отправляет клиенту. Тут ИИ не заменяет оператора, а выступает помощником‑подсказчиком: он экономит время на типовые запросы и оставляет операторам больше ресурса для сложных задач.
Сейчас мы готовим ещё одну доработку — скрипты базовых автоматизаций вроде массового добавления пользователей или редактирования тегов сотрудников. Так клиенты без сильных технических навыков в программировании смогут следовать готовым шагам, которые мы подготовили с помощью ИИ, и запускать автоматизации самостоятельно.
Вот пример готового промпта для скрипта для единовременного создания нескольких чатов и добавления в них юзеров:
Привет! Я хочу сделать API-автоматизацию, которая позволила бы мне создать сразу несколько групповых чатов в Пачке и добавить в них юзеров. Для этого используй нужные методы API, изучи документацию: https://crm.pachca.com/dev/llms.txt. Затем подробно объясни, как мне запускать эту автоматизацию.
Как добавить llms.txt для своей документации
Можно автоматизировать этот процесс с помощью скриптов или специальных сервисов. Мы, например, написали свой мини-конвертер, который при добавлении новой страницы в документацию автоматически создает ее Markdown версию и добавляет в llms.txt. Но можно сделать все и своими руками.
Для добавления вручную:
- Создайте файл в формате Markdown
- Начните заполнять файл с заголовка первого уровня #, указав название сайта
- Добавьте краткое описание в виде цитаты > (1–2 строки)
- Разбейте контент на ключевые разделы, дайте им названия и пометьте подзаголовками ##
- В каждом разделе перечислите важные ссылки обычными маркерами Markdown в формате: [навание раздела](ссылка на раздел)
- При необходимости добавьте раздел Optional для страниц низкого приоритета
- Разместите файл по адресу /llms.txt. Поместите его в корневую папку сайта, рядом с robots.txt, или, при необходимости, в подпапку /docs/llms.txt. Убедитесь, что текст файла доступен по этой ссылке без лишнего HTML
Больше деталей по стандарту llms.txt — на llmstxt.org
Делитесь в комментариях, какие задачи уже автоматизируете с помощью ИИ, или что мешает начать!