Для разработчиков

Прямые запросы

Команда pachca api делает две вещи:

  • прямой HTTP-запрос к любому методу API — для нестандартных вызовов, отладки или метода без удобной обёртки
  • встроенный справочник по API — список методов и справку по каждому (параметры, тело, схема, пример) можно получить прямо в терминале, не открывая сайт документации

Для типовых задач удобнее типизированные команды — так написаны все примеры в документации и интеграции. Команда pachca api дополняет их.

Прямой HTTP-запрос

# GET с query paramspachca api GET /messages --query chat_id=123 # POST с типизированными полями (-F конвертирует числа и boolean)pachca api POST /messages -F 'message[entity_id]=12345' -f 'message[content]=Привет' # PUT со строковым полем (-f гарантирует string)pachca api PUT /tasks/42 -f 'task[due_at]=2026-04-01T10:00:00Z' # Отправить готовый JSON-файлpachca api POST /messages --input payload.json # Инлайн JSON-строка (самодостаточная команда — удобно для агентов)pachca api POST /messages --data '{"message":{"entity_id":123,"content":"Привет"}}' # Из stdincat payload.json | pachca api POST /messages --input -

Имена полей с квадратными скобками берите в кавычки: zsh считает [...] шаблоном имён файлов и без кавычек обрывает команду ошибкой no matches found.

-F превращает true, false, null и числа в значения JSON, а @файл подставляет содержимое файла строкой. -f всегда передаёт строку. Тело задают одним способом: полями -f и -F, файлом --input или строкой --data. Вместе их передать нельзя, команда ответит ошибкой PACHCA_USAGE_ERROR.

Чтобы передать несколько значений одного параметра, повторите --query с тем же именем: CLI отправит все значения по порядку. Так передают параметр-массив, например company_roles[]:

pachca api GET /search/users --query 'company_roles[]=admin' --query 'company_roles[]=user'

Команда pachca api DELETE удаляет сразу, без подтверждения, подробнее — в разделе Деструктивные операции.

Команда pachca api выводит сырой ответ API без извлечения данных из обёртки data

Встроенный справочник по API

Не нужно искать путь и параметры на сайте документации — список методов и справку по каждому CLI показывает прямо в терминале. Данные генерируются из той же OpenAPI-спецификации, из которой собран сам CLI, поэтому совпадают с командами установленной версии.

api ls, --describe, --spec и --docs читают встроенную спецификацию и работают до pachca auth login: токен и сеть им не нужны.

# Список всех методов (METHOD PATH SUMMARY SCOPE)pachca api ls #  METHOD  PATH        SUMMARY                 SCOPE#  POST    /chats      Новый чат               chats:create#  GET     /chats      Список чатов            chats:read#  POST    /messages   Новое сообщение         messages:create#  GET     /messages   Список сообщений чата   messages:read#  ...     весь список методов API # То же машиночитаемоpachca api ls --json # [#   { "method": "POST", "path": "/messages", "summary": "Новое сообщение", "scope": "messages:create" },#   ...# ] # Краткая справка по методу: параметры, тело, скоуп, эквивалентная командаpachca api POST /messages --describe # # POST /messages — Новое сообщение## > **Скоуп:** `messages:create`## ## Тело запроса# - message: object (required) — Собранный объект параметров создаваемого сообщения#   - entity_id: integer (required) — Идентификатор того, что названо в entity_type#   - content: string — Текст сообщения#   ...## ## Эквивалентная команда#   pachca messages create --entity-id=334 --content='...' --json --token YOUR_ACCESS_TOKEN # OpenAPI-фрагмент метода (схемы запроса и ответа)pachca api GET /messages --spec # {#   "method": "GET",#   "path": "/messages",#   "parameters": [#     { "name": "chat_id", "in": "query", "required": true, ... },#     ...#   ]# } # Полная справка по методу в Markdown (как на сайте документации)pachca api POST /messages --docs # # Новое сообщение## **Метод**: `POST`## **Путь**: `/messages`## > **Скоуп:** `messages:create`## ## Тело запроса# ...

Эквивалентная команда в --describe повторяет пример запроса из справки метода: её можно скопировать и запустить, подставив свои значения.

Метод указывается позиционно, поэтому --describe/--spec/--docs всегда однозначны — отдельный -X не нужен.

Полезно и агентам: они в основном работают типизированными командами, а когда нужного метода нет под рукой — api ls/--describe дают точечную справку, не загружая всю документацию в контекст.