# API сервиса Яндекс Магистрали для ИИ-агентов

## Как читать документацию

1. Выберите сценарий по задаче и роли. Условия доступа и работы с данными описаны в статье [Порядок работы для агента](https://yamagistrali.ru/docs/ru-x-ai/concepts/agent-workflow.md).
2. Откройте карточки методов по ссылкам из шагов.
3. Для генерации клиента используйте [инструкцию](https://yamagistrali.ru/docs/ru-x-ai/guides/generate-client.md) и [OpenAPI (YAML)](https://yamagistrali.ru/docs/ru-x-ai/catalog/openapi.yaml).

## Документация

- [OpenAPI (JSON)](https://yamagistrali.ru/docs/ru-x-ai/openapi.openapi.json): Спецификация OpenAPI
- [Описание API сервиса Яндекс Магистрали для ИИ-агентов](https://yamagistrali.ru/docs/ru-x-ai/index.md): Как передать ИИ-агенту документацию по API сервиса Яндекс Магистрали, поставить первую задачу и настроить доступ.
- [Доступ к API](https://yamagistrali.ru/docs/ru-x-ai/guides/api-access.md): Как выбрать стенд, получить токен, настроить авторизацию и проверить учётную запись и роль перед вызовом API.
- [Хранение секретов](https://yamagistrali.ru/docs/ru-x-ai/guides/secrets.md): Как согласовать с пользователем способ хранения токена и передать его клиенту без раскрытия значения.
- [Генерация клиента из OpenAPI](https://yamagistrali.ru/docs/ru-x-ai/guides/generate-client.md): Как выбрать или сгенерировать клиент из OpenAPI, подключить авторизацию и проверить вызовы на тестовом стенде.
- [Порядок работы для агента](https://yamagistrali.ru/docs/ru-x-ai/concepts/agent-workflow.md): Как выбрать сценарий и стенд, подготовить запрос и обработать ответ.
- [Работа с персональными и чувствительными данными](https://yamagistrali.ru/docs/ru-x-ai/concepts/sensitive-data.md): Как ИИ-агенту выбрать необходимые данные, обработать их в клиенте и проверить условия раскрытия.
- [Синхронизация заказов и рейсов по лентам изменений](https://yamagistrali.ru/docs/ru-x-ai/concepts/order-sync.md): Как читать отдельные ленты заказов и рейсов, обрабатывать изменения и сохранять курсоры в клиенте.
- [Сценарии заказчика](https://yamagistrali.ru/docs/ru-x-ai/catalog/customer/index.md)
- [Проверить доступ к API для заказчика](https://yamagistrali.ru/docs/ru-x-ai/catalog/customer/customer-api-access-and-identity.md)
- [Отменить или отозвать заказ заказчика](https://yamagistrali.ru/docs/ru-x-ai/catalog/customer/customer-cancel-revoke.md)
- [Добавить комментарий и посмотреть файлы заказа со стороны заказчика](https://yamagistrali.ru/docs/ru-x-ai/catalog/customer/customer-comments-files.md)
- [Создать заказ на перевозку](https://yamagistrali.ru/docs/ru-x-ai/catalog/customer/customer-create-order.md)
- [Следить за торгами и выбрать победителя](https://yamagistrali.ru/docs/ru-x-ai/catalog/customer/customer-demand-basic-flow.md)
- [Получить заказ для редактирования и обновить его](https://yamagistrali.ru/docs/ru-x-ai/catalog/customer/customer-get-update-order.md)
- [Найти заказы заказчика и получить их детали](https://yamagistrali.ru/docs/ru-x-ai/catalog/customer/customer-list-orders.md)
- [Получать изменения рейсов заказчика](https://yamagistrali.ru/docs/ru-x-ai/catalog/customer/customer-poll-flight-changes.md)
- [Получать изменения заказов заказчика](https://yamagistrali.ru/docs/ru-x-ai/catalog/customer/customer-poll-order-changes.md)
- [Подготовить справочники, адреса и узловые точки для заказа](https://yamagistrali.ru/docs/ru-x-ai/catalog/customer/customer-prepare-dictionaries-suggests.md)
- [Создать шаблон заказа и получить его данные](https://yamagistrali.ru/docs/ru-x-ai/catalog/customer/customer-templates.md)
- [Сценарии исполнителя](https://yamagistrali.ru/docs/ru-x-ai/catalog/executor/index.md)
- [Проверить доступ к API для исполнителя](https://yamagistrali.ru/docs/ru-x-ai/catalog/executor/executor-api-access-and-identity.md)
- [Назначить на рейс водителя, тягач и прицеп](https://yamagistrali.ru/docs/ru-x-ai/catalog/executor/executor-assign-vehicle-driver-trailer.md)
- [Добавить комментарий и получить файлы заказа со стороны исполнителя](https://yamagistrali.ru/docs/ru-x-ai/catalog/executor/executor-comments-files.md)
- [Завершить исполнение заказа или отказаться от него](https://yamagistrali.ru/docs/ru-x-ai/catalog/executor/executor-complete-or-revoke-execution.md)
- [Создать рейс и назначить порядок выполнения задач](https://yamagistrali.ru/docs/ru-x-ai/catalog/executor/executor-create-manage-flight.md)
- [Сделать, изменить или отменить ставку на торгах](https://yamagistrali.ru/docs/ru-x-ai/catalog/executor/executor-create-update-cancel-bid.md)
- [Найти заказы исполнителя и получить их детали](https://yamagistrali.ru/docs/ru-x-ai/catalog/executor/executor-get-order-details.md)
- [Получать изменения рейсов исполнителя](https://yamagistrali.ru/docs/ru-x-ai/catalog/executor/executor-poll-flight-changes.md)
- [Получать изменения заказов исполнителя](https://yamagistrali.ru/docs/ru-x-ai/catalog/executor/executor-poll-order-changes.md)
- [Методы API](https://yamagistrali.ru/docs/ru-x-ai/methods/index.md)
- [Отменить ставку](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-bet-cancel-v0.md)
- [Сделать ставку](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-bet-create-v1.md)
- [Добавить комментарий к рейсу](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-comments-create-by-executer-v0.md)
- [Получить комментарии к рейсу](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-comments-get-by-executer-v0.md)
- [Выбрать победителя торгов](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-choosewinner-v0.md)
- [Получить список торгов заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md)
- [Получить типы кузовов](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-bodytypes-v0-bodytypesget.md)
- [Получить список стран](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-countries-v0-countriesget.md)
- [Получить валюты заказов](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-currency-v0-ordercurrencyget.md)
- [Получить способы погрузки и выгрузки](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-downloadtypes-v0-downloadtypesget.md)
- [Получить организационно-правовые формы](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-legalforms-v0-legalformsget.md)
- [Получить причины отмены черновика](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-order-v0-reasonordercancel.md)
- [Получить причины отзыва заказа исполнителем](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-order-v0-reasonorderrevokeexec.md)
- [Получить причины отзыва заказа заказчиком](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-order-v0-reasonorderrevokefwd.md)
- [Получить типы упаковки](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-packagetype-v0-packagetypeget.md)
- [Получить категории груза](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-productcategories-v0-productcategoriesget.md)
- [Получить температурные режимы](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-dicts-temperatureconditions-v0-temperatureconditionsget.md)
- [Получить изменения рейсов исполнителя](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flight-changesforexecutors-get-v0.md)
- [Получить начальный курсор изменений рейсов исполнителя](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flight-changesforexecutors-getlastlogid-v0.md)
- [Получить изменения рейсов заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flights-changesforforwarders-get-v0.md)
- [Получить начальный курсор изменений рейсов заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flights-changesforforwarders-getlastlogid-v0.md)
- [Получить файл комментария к рейсу](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flights-comments-getfilebyexecutor-v0.md)
- [Завершить рейс](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flights-complete-v0.md)
- [Создать рейс](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flights-create-v1.md)
- [Назначить водителя на рейс](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flights-driver-set-v1.md)
- [Задать порядок задач рейса](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flights-order-setbulk-v1.md)
- [Добавить задачи в рейс](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flights-tasks-addbulk-v1.md)
- [Назначить прицеп на рейс](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flights-trailer-set-v1.md)
- [Назначить тягач на рейс](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flights-truck-set-v1.md)
- [Получить рейсы исполнителя](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flights-v1-listforexecutor.md)
- [Получить рейсы заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-flights-v1-listforforwarder.md)
- [Найти координаты по адресу](https://yamagistrali.ru/docs/ru-x-ai/methods/geo.geocoder.v2.md)
- [Найти координаты адреса по подсказкам](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-geocoder-yaproxy-v1.md)
- [Найти узловые точки по адресу](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-nodalpoint-suggestwithgeodatabyaddress-v0.md)
- [Получить изменения заказов исполнителя](https://yamagistrali.ru/docs/ru-x-ai/methods/orders.changes-for-executors.get.v0.md)
- [Получить начальный курсор изменений заказов исполнителя](https://yamagistrali.ru/docs/ru-x-ai/methods/orders.changes-for-executors.get-last-log-id.v0.md)
- [Получить изменения заказов заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/orders.changes-for-forwarders.get.v0.md)
- [Получить начальный курсор изменений заказов заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/orders.changes-for-forwarders.get-last-log-id.v0.md)
- [Добавить комментарий к заказу со стороны исполнителя](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-comments-create-by-executer-v0.md)
- [Добавить комментарий к заказу со стороны заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-comments-create-by-forwarder-v0.md)
- [Получить комментарии к заказу со стороны исполнителя](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-comments-get-by-executer-v0.md)
- [Получить комментарии к заказу со стороны заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-comments-get-by-forwarder-v0.md)
- [Получить файл комментария к заказу](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-comments-getfilebyexecutor-v0.md)
- [Отменить черновик заказа](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-draft-cancel-v0.md)
- [Скачать файл заказа со стороны исполнителя](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-file-forexecutor-v0.md)
- [Скачать файл заказа со стороны заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-file-forforwarder-v0.md)
- [Получить список файлов заказа со стороны исполнителя](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-file-listforexecutor-v0.md)
- [Получить список файлов заказа со стороны заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-file-listforforwarder-v0.md)
- [Завершить исполнение заказа](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-onexecute-completebyexecutor-v0.md)
- [Отозвать исполнение заказа со стороны исполнителя](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-onexecute-revokebyexecutor-v0.md)
- [Отозвать исполняемый заказ со стороны заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-onexecute-revokebyforwarder-v0.md)
- [Создать заказ на перевозку](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-v0-transferorder-create.md)
- [Получить доступные организации с ролью заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-forwarder-allow.md)
- [Получить полные карточки заказов заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/orders.transfer-order.get-flat-for-customer.v0.md)
- [Получить полные карточки заказов исполнителя](https://yamagistrali.ru/docs/ru-x-ai/methods/orders.transfer-order.get-flat-for-executor.v0.md)
- [Получить заказ для редактирования](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md)
- [Получить идентификаторы заказов заказчика](https://yamagistrali.ru/docs/ru-x-ai/methods/orders.transfer-order.get-ids-for-customer.v0.md)
- [Получить идентификаторы заказов исполнителя](https://yamagistrali.ru/docs/ru-x-ai/methods/orders.transfer-order.get-ids-for-executor.v0.md)
- [Обновить заказ на перевозку](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-orders-v0-transferorder-update.md)
- [Создать шаблон заказа](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-transferordertemplate-create-v2.md)
- [Получить шаблон заказа](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-transferordertemplate-get-v2.md)
- [Получить список шаблонов заказа](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-transferordertemplate-gettemplatenames-v0.md)
- [Получить идентификаторы текущего пользователя](https://yamagistrali.ru/docs/ru-x-ai/methods/user.get-ya-id.v0.md)
- [Получить доступные профили сотрудников](https://yamagistrali.ru/docs/ru-x-ai/methods/users.user-employees.get-list.v0.md)

---

Сводный экспорт всех страниц и схем доступен в [llms-full.txt](https://yamagistrali.ru/docs/ru-x-ai/llms-full.txt)