---
title: "Справочник эндпоинтов API v1 tuk-tuk.online: все адреса и права"
nav_title: "Справочник эндпоинтов"
url: https://docs.tuk-tuk.online/api/reference
markdown: https://docs.tuk-tuk.online/api/reference.md
section: "API для разработчиков"
description: "Полный список эндпоинтов публичного API tuk-tuk.online: 96 адресов в 12 ресурсах, метод, назначение и требуемый scope. Генерируется из каталога возможностей платформы."
keywords: ["API справочник", "список эндпоинтов", "REST API v1", "scopes", "права API-ключа", "manifest", "openapi", "API мессенджеров"]
lang: ru
product: tuk-tuk.online
app: https://lk.tuk-tuk.online
api_base: https://back.tuk-tuk.online
---

> [!AI] Кратко
> Полный справочник публичного API tuk-tuk.online v1.1.0: 96 эндпоинтов в 12 ресурсах с указанием метода, адреса, назначения и требуемого права.
>
> - API v1 версии 1.1.0: 12 ресурсов, 96 эндпоинтов, базовый адрес https://back.tuk-tuk.online/api/v1.
> - Каталог эндпоинтов, /manifest, /openapi.json и эта страница собираются из одного источника и не расходятся.
> - Ключ и рабочее пространство: 5 эндпоинтов, а именно GET /me, GET /manifest, GET /openapi.json, GET /account, GET /account/dashboard.
> - Каналы связи: 1 эндпоинт, а именно GET /messengers.
> - Контакты: 6 эндпоинтов, а именно GET /contacts, POST /contacts, GET /contacts/{id}, PATCH /contacts/{id}, POST /contacts/{id}/notes, GET /contacts/{id}/messages.
> - Сообщения: 4 эндпоинта, а именно POST /messages, POST /messages/schedule, GET /messages/scheduled, DELETE /messages/scheduled/{id}.
> - Файлы: 3 эндпоинта, а именно GET /media/{fileId}, GET /files, POST /files.
> - Рассылки: 14 эндпоинтов, а именно GET /broadcasts, POST /broadcasts, POST /broadcasts/preview, GET /broadcasts/audience/options, GET /broadcasts/{id}, PATCH /broadcasts/{id}, DELETE /broadcasts/{id}, POST /broadcasts/{id}/start, POST /broadcasts/{id}/pause, POST /broadcasts/{id}/resume, POST /broadcasts/{id}/cancel, POST /broadcasts/{id}/duplicate, POST /broadcasts/{id}/retry-failed, GET /broadcasts/{id}/recipients.
> - Связки: 10 эндпоинтов, а именно GET /chains/block-types, GET /chains/templates, POST /chains/from-template, GET /chains, POST /chains, GET /chains/{id}, PATCH /chains/{id}, DELETE /chains/{id}, POST /chains/{id}/toggle, POST /chains/{id}/clone.
> - Воронки автопостинга: 14 эндпоинтов, а именно GET /funnels/block-types, GET /funnels, POST /funnels, GET /funnels/{id}, PATCH /funnels/{id}, DELETE /funnels/{id}, GET /funnels/{id}/blocks, PUT /funnels/{id}/blocks, POST /funnels/{id}/blocks, PATCH /funnels/{id}/blocks/{blockId}, DELETE /funnels/{id}/blocks/{blockId}, GET /funnels/{id}/runs, POST /funnels/{id}/run, POST /funnels/{id}/stop.
> - ИИ-ассистенты: 10 эндпоинтов, а именно GET /assistants, POST /assistants, GET /assistants/{id}, PATCH /assistants/{id}, DELETE /assistants/{id}, POST /assistants/{id}/toggle, POST /assistants/pause-all, POST /assistants/resume-all, POST /assistants/pause-dialog, DELETE /assistants/pause-dialog/{dialogId}.
> - Нейросети: 16 эндпоинтов, а именно GET /ai/catalog, GET /ai/tools, GET /ai/providers, POST /ai/providers, PATCH /ai/providers/{id}, DELETE /ai/providers/{id}, POST /ai/providers/{id}/test, GET /ai/knowledge, POST /ai/knowledge, PATCH /ai/knowledge/{id}, DELETE /ai/knowledge/{id}, GET /ai/knowledge/search, POST /ai/knowledge/reindex, GET /ai/logs, GET /ai/usage, POST /ai/chat.
> - Задачи: 5 эндпоинтов, а именно GET /tasks, POST /tasks, GET /tasks/{id}, PATCH /tasks/{id}, DELETE /tasks/{id}.
> - События: 8 эндпоинтов, а именно GET /events/types, GET /events/subscriptions, POST /events/subscriptions, GET /events/subscriptions/{id}, PATCH /events/subscriptions/{id}, DELETE /events/subscriptions/{id}, POST /events/subscriptions/{id}/rotate-secret, GET /events/subscriptions/{id}/deliveries.
>
> Связанные страницы: https://docs.tuk-tuk.online/api/rest, https://docs.tuk-tuk.online/api/mcp-tools, https://docs.tuk-tuk.online/api/recipes, https://docs.tuk-tuk.online/api/agents, https://docs.tuk-tuk.online/api/webhooks

# Справочник эндпоинтов API v1

Все 96 эндпоинтов публичного API одним списком: адрес, назначение и право, которое нужно ключу. Страница собирается из того же каталога, что кормит `GET /api/v1/manifest` и `GET /api/v1/openapi.json`, поэтому отстать от кода она не может.

| Параметр | Значение |
|---|---|
| Версия API | `1.1.0` |
| Базовый адрес | `https://back.tuk-tuk.online/api/v1` |
| Ресурсов | 12 |
| Эндпоинтов | 96 |
| Авторизация | `Authorization: Bearer tuk_sk_…` либо `X-Api-Key` |

> [!TIP] Агенту достаточно двух вызовов, чтобы сориентироваться: `GET /manifest` покажет, что доступно именно этому ключу, `GET /openapi.json` отдаст схемы запросов и ответов. Оба не требуют дополнительных прав.

## Ресурсы

| Ресурс | Эндпоинтов | Что внутри |
|---|---|---|
| [Ключ и рабочее пространство](#klyuch-i-rabochee-prostranstvo) | 5 | Кто мы, что разрешено ключу, сколько денег и лимитов осталось. |
| [Каналы связи](#kanaly-svyazi) | 1 | Подключённые мессенджеры, почта, SMS-шлюз и чат-виджет. Секреты каналов не отдаются. |
| [Контакты](#kontakty) | 6 | Карточки клиентов: поиск, создание, теги, произвольные поля, статусы, заметки. |
| [Сообщения](#soobscheniya) | 4 | Отправка в любой подключённый канал, включая отложенную на конкретное время. |
| [Файлы](#fayly) | 3 | Постоянное хранилище вложений: ссылка не протухнет, своего хостинга не нужно. |
| [Рассылки](#rassylki) | 14 | Сегмент клиентов, темп отправки, окно по времени, отчёт по каждому получателю. |
| [Связки](#svyazki) | 10 | Автоматические сценарии на входящее сообщение: ветвления, задержки, ИИ, вебхуки, код. |
| [Воронки автопостинга](#voronki-avtopostinga) | 14 | Сторис и посты по расписанию, в том числе зациклённые. Схема из блоков. |
| [ИИ-ассистенты](#ii-assistenty) | 10 | Кто отвечает клиентам автоматически. Паузу в конкретном диалоге можно забрать себе. |
| [Нейросети](#neyroseti) | 16 | Какие модели существуют, что подключено у клиента, чем ассистент может пользоваться.  |
| [Задачи](#zadachi) | 5 | Задачи CRM: статус, приоритет, исполнитель, дедлайн, привязка к контакту. |
| [События](#sobytiya) | 8 | Подписка на события платформы: входящее сообщение приходит на ваш URL само, поллинг не нужен. |

## Ключ и рабочее пространство

Кто мы, что разрешено ключу, сколько денег и лимитов осталось.

| Метод | Адрес | Что делает | Право |
|---|---|---|---|
| `GET` | `/api/v1/me` | Имя ключа, его scopes и рабочее пространство | любой ключ |
| `GET` | `/api/v1/manifest` | Машиночитаемое описание API и доступных этому ключу возможностей | любой ключ |
| `GET` | `/api/v1/openapi.json` | Спецификация OpenAPI 3.1 целиком | любой ключ |
| `GET` | `/api/v1/account` | Баланс, тариф, фактические лимиты с учётом расширений, разложенный счёт за подписку, расход сообщений | `account:read` |
| `GET` | `/api/v1/account/dashboard` | Сводка рабочего стола: деньги, объёмы, диалоги, пики, сегментация | `account:read` |

## Каналы связи

Подключённые мессенджеры, почта, SMS-шлюз и чат-виджет. Секреты каналов не отдаются.

| Метод | Адрес | Что делает | Право |
|---|---|---|---|
| `GET` | `/api/v1/messengers` | Список подключённых каналов со статусом | `messengers:read` |

## Контакты

Карточки клиентов: поиск, создание, теги, произвольные поля, статусы, заметки.

| Метод | Адрес | Что делает | Право |
|---|---|---|---|
| `GET` | `/api/v1/contacts` | Список с фильтрами либо точечный поиск по phone/email | `contacts:read` |
| `POST` | `/api/v1/contacts` | Создать карточку клиента | `contacts:write` |
| `GET` | `/api/v1/contacts/{id}` | Карточка по ID | `contacts:read` |
| `PATCH` | `/api/v1/contacts/{id}` | Обновить имя, контакты, теги, поля, статус, архив | `contacts:write` |
| `POST` | `/api/v1/contacts/{id}/notes` | Внутренняя заметка, клиенту не уходит | `contacts:write` |
| `GET` | `/api/v1/contacts/{id}/messages` | История переписки, свежие сверху | `messages:read` |

## Сообщения

Отправка в любой подключённый канал, включая отложенную на конкретное время.

| Метод | Адрес | Что делает | Право |
|---|---|---|---|
| `POST` | `/api/v1/messages` | Отправить текст, медиа, голосовое или письмо | `messages:send` |
| `POST` | `/api/v1/messages/schedule` | Поставить сообщение на конкретное время | `messages:send` |
| `GET` | `/api/v1/messages/scheduled` | Что стоит в очереди и ещё не ушло | `messages:send` |
| `DELETE` | `/api/v1/messages/scheduled/{id}` | Отменить отложенное до отправки | `messages:send` |

## Файлы

Постоянное хранилище вложений: ссылка не протухнет, своего хостинга не нужно.

| Метод | Адрес | Что делает | Право |
|---|---|---|---|
| `GET` | `/api/v1/media/{fileId}` | Метаданные и ссылка на скачивание | `media:read` |
| `GET` | `/api/v1/files` | Список файлов рабочего пространства | `media:read` |
| `POST` | `/api/v1/files` | Забрать файл по ссылке в хранилище и получить постоянный URL | `files:write` |

## Рассылки

Сегмент клиентов, темп отправки, окно по времени, отчёт по каждому получателю.

| Метод | Адрес | Что делает | Право |
|---|---|---|---|
| `GET` | `/api/v1/broadcasts` | Список рассылок | `broadcasts:read` |
| `POST` | `/api/v1/broadcasts` | Создать черновик рассылки | `broadcasts:write` |
| `POST` | `/api/v1/broadcasts/preview` | Посчитать аудиторию до запуска | `broadcasts:read` |
| `GET` | `/api/v1/broadcasts/audience/options` | Какие теги есть и сколько под ними контактов | `broadcasts:read` |
| `GET` | `/api/v1/broadcasts/{id}` | Рассылка целиком, вместе с прогрессом | `broadcasts:read` |
| `PATCH` | `/api/v1/broadcasts/{id}` | Изменить текст, аудиторию, темп, расписание | `broadcasts:write` |
| `DELETE` | `/api/v1/broadcasts/{id}` | Удалить рассылку | `broadcasts:write` |
| `POST` | `/api/v1/broadcasts/{id}/start` | Запустить или поставить в расписание, только из черновика и запланированной | `broadcasts:write` |
| `POST` | `/api/v1/broadcasts/{id}/pause` | Пауза: остаток получателей ждёт продолжения | `broadcasts:write` |
| `POST` | `/api/v1/broadcasts/{id}/resume` | Продолжить после паузы | `broadcasts:write` |
| `POST` | `/api/v1/broadcasts/{id}/cancel` | Остановить без возможности продолжить | `broadcasts:write` |
| `POST` | `/api/v1/broadcasts/{id}/duplicate` | Копия рассылки: повторить завершённую без дублей получателям | `broadcasts:write` |
| `POST` | `/api/v1/broadcasts/{id}/retry-failed` | Повторить для тех, кому не дошло | `broadcasts:write` |
| `GET` | `/api/v1/broadcasts/{id}/recipients` | Отчёт доставки по каждому получателю | `broadcasts:read` |

## Связки

Автоматические сценарии на входящее сообщение: ветвления, задержки, ИИ, вебхуки, код.

| Метод | Адрес | Что делает | Право |
|---|---|---|---|
| `GET` | `/api/v1/chains/block-types` | Справочник типов блоков | `chains:read` |
| `GET` | `/api/v1/chains/templates` | Готовые сценарии: те же, что видит оператор | `chains:read` |
| `POST` | `/api/v1/chains/from-template` | Связка из шаблона, блоки собраны заранее | `chains:write` |
| `GET` | `/api/v1/chains` | Список связок | `chains:read` |
| `POST` | `/api/v1/chains` | Создать связку, сразу с блоками | `chains:write` |
| `GET` | `/api/v1/chains/{id}` | Связка вместе с блоками | `chains:read` |
| `PATCH` | `/api/v1/chains/{id}` | Изменить блоки, триггер, условия запуска | `chains:write` |
| `DELETE` | `/api/v1/chains/{id}` | Удалить связку | `chains:write` |
| `POST` | `/api/v1/chains/{id}/toggle` | Включить или выключить | `chains:write` |
| `POST` | `/api/v1/chains/{id}/clone` | Копия связки: править эксперимент, не трогая рабочую | `chains:write` |

## Воронки автопостинга

Сторис и посты по расписанию, в том числе зациклённые. Схема из блоков.

| Метод | Адрес | Что делает | Право |
|---|---|---|---|
| `GET` | `/api/v1/funnels/block-types` | Справочник блоков воронки | `funnels:read` |
| `GET` | `/api/v1/funnels` | Список воронок | `funnels:read` |
| `POST` | `/api/v1/funnels` | Создать воронку | `funnels:write` |
| `GET` | `/api/v1/funnels/{id}` | Воронка целиком | `funnels:read` |
| `PATCH` | `/api/v1/funnels/{id}` | Переименовать, поменять канал и настройки | `funnels:write` |
| `DELETE` | `/api/v1/funnels/{id}` | Удалить воронку | `funnels:write` |
| `GET` | `/api/v1/funnels/{id}/blocks` | Блоки воронки | `funnels:read` |
| `PUT` | `/api/v1/funnels/{id}/blocks` | Заменить схему блоков целиком | `funnels:write` |
| `POST` | `/api/v1/funnels/{id}/blocks` | Добавить блок | `funnels:write` |
| `PATCH` | `/api/v1/funnels/{id}/blocks/{blockId}` | Изменить блок | `funnels:write` |
| `DELETE` | `/api/v1/funnels/{id}/blocks/{blockId}` | Удалить блок, сшив соседние связи | `funnels:write` |
| `GET` | `/api/v1/funnels/{id}/runs` | История запусков | `funnels:read` |
| `POST` | `/api/v1/funnels/{id}/run` | Запустить воронку | `funnels:write` |
| `POST` | `/api/v1/funnels/{id}/stop` | Остановить воронку | `funnels:write` |

## ИИ-ассистенты

Кто отвечает клиентам автоматически. Паузу в конкретном диалоге можно забрать себе.

| Метод | Адрес | Что делает | Право |
|---|---|---|---|
| `GET` | `/api/v1/assistants` | Список ассистентов со статистикой | `assistants:read` |
| `POST` | `/api/v1/assistants` | Создать ассистента: роль, действия, каналы | `assistants:write` |
| `GET` | `/api/v1/assistants/{id}` | Ассистент целиком | `assistants:read` |
| `PATCH` | `/api/v1/assistants/{id}` | Настройка, модель, каналы, часы работы, действия, суточный лимит | `assistants:write` |
| `DELETE` | `/api/v1/assistants/{id}` | Удалить ассистента | `assistants:write` |
| `POST` | `/api/v1/assistants/{id}/toggle` | Включить или выключить | `assistants:write` |
| `POST` | `/api/v1/assistants/pause-all` | Замолчать всем на N минут, сохранив настройки | `assistants:write` |
| `POST` | `/api/v1/assistants/resume-all` | Вернуть всех в работу | `assistants:write` |
| `POST` | `/api/v1/assistants/pause-dialog` | Отдать диалог человеку или внешнему агенту на N минут | `assistants:write` |
| `DELETE` | `/api/v1/assistants/pause-dialog/{dialogId}` | Вернуть диалог ассистенту | `assistants:write` |

## Нейросети

Какие модели существуют, что подключено у клиента, чем ассистент может пользоваться. 

| Метод | Адрес | Что делает | Право |
|---|---|---|---|
| `GET` | `/api/v1/ai/catalog` | Каталог нейросетей и их моделей: цена, контекст, умения | `ai:read` |
| `GET` | `/api/v1/ai/tools` | Действия, которые можно доверить ассистенту, со схемой параметров | `ai:read` |
| `GET` | `/api/v1/ai/providers` | Подключённые нейросети и состояние их ключей | `ai:read` |
| `POST` | `/api/v1/ai/providers` | Подключить нейросеть по ключу клиента | `ai:write` |
| `PATCH` | `/api/v1/ai/providers/{id}` | Сменить ключ, модель или название | `ai:write` |
| `DELETE` | `/api/v1/ai/providers/{id}` | Отключить нейросеть | `ai:write` |
| `POST` | `/api/v1/ai/providers/{id}/test` | Проверить ключ и обновить список моделей от вендора | `ai:write` |
| `GET` | `/api/v1/ai/knowledge` | Файлы базы знаний, по которым отвечает ассистент | `ai:read` |
| `POST` | `/api/v1/ai/knowledge` | Добавить прайс, условия, ответы на вопросы | `ai:write` |
| `PATCH` | `/api/v1/ai/knowledge/{id}` | Изменить файл знаний | `ai:write` |
| `DELETE` | `/api/v1/ai/knowledge/{id}` | Удалить файл знаний | `ai:write` |
| `GET` | `/api/v1/ai/knowledge/search` | Поиск по базе знаний, тот же, что у ассистента | `ai:read` |
| `POST` | `/api/v1/ai/knowledge/reindex` | Пересобрать поисковый индекс | `ai:write` |
| `GET` | `/api/v1/ai/logs` | Журнал обращений: запрос, ответ, действия, ошибки | `ai:read` |
| `GET` | `/api/v1/ai/usage` | Сводка за сутки: обращения, сбои, токены | `ai:read` |
| `POST` | `/api/v1/ai/chat` | Разовый запрос к нейросети клиента | `ai:write` |

## Задачи

Задачи CRM: статус, приоритет, исполнитель, дедлайн, привязка к контакту.

| Метод | Адрес | Что делает | Право |
|---|---|---|---|
| `GET` | `/api/v1/tasks` | Список задач, с фильтром по статусу и контакту | `tasks:read` |
| `POST` | `/api/v1/tasks` | Создать задачу | `tasks:write` |
| `GET` | `/api/v1/tasks/{id}` | Задача целиком | `tasks:read` |
| `PATCH` | `/api/v1/tasks/{id}` | Изменить задачу | `tasks:write` |
| `DELETE` | `/api/v1/tasks/{id}` | Удалить задачу | `tasks:write` |

## События

Подписка на события платформы: входящее сообщение приходит на ваш URL само, поллинг не нужен.

| Метод | Адрес | Что делает | Право |
|---|---|---|---|
| `GET` | `/api/v1/events/types` | Каталог событий | `webhooks:manage` |
| `GET` | `/api/v1/events/subscriptions` | Список подписок | `webhooks:manage` |
| `POST` | `/api/v1/events/subscriptions` | Создать подписку, секрет возвращается один раз | `webhooks:manage` |
| `GET` | `/api/v1/events/subscriptions/{id}` | Подписка целиком | `webhooks:manage` |
| `PATCH` | `/api/v1/events/subscriptions/{id}` | Изменить URL, набор событий, активность | `webhooks:manage` |
| `DELETE` | `/api/v1/events/subscriptions/{id}` | Удалить подписку | `webhooks:manage` |
| `POST` | `/api/v1/events/subscriptions/{id}/rotate-secret` | Новый секрет подписи | `webhooks:manage` |
| `GET` | `/api/v1/events/subscriptions/{id}/deliveries` | История доставок | `webhooks:manage` |

## Права (scopes)

Ключ выпускается с набором прав. Право, которого нет у ключа, отвечает `403 forbidden_scope`, а инструмент MCP с таким правом агенту даже не показывается.

| Право | Что открывает |
|---|---|
| `messengers:read` | Просмотр списка привязанных мессенджеров/каналов |
| `contacts:read` | Чтение карточек контактов (диалогов) |
| `contacts:write` | Создание и изменение контактов: имя, телефон, email, теги, поля, статус, заметки |
| `messages:read` | Чтение истории сообщений |
| `media:read` | Получение ссылок на медиа-вложения |
| `messages:send` | Отправка сообщений / email / голосовых, в том числе отложенных |
| `files:write` | Загрузка файлов в хранилище рабочего пространства |
| `funnels:read` | Чтение воронок мессенджера и справочника типов блоков |
| `funnels:write` | Создание и изменение воронок, их блоков и связей, запуск/остановка |
| `broadcasts:read` | Чтение рассылок, их аудитории и статистики доставки |
| `broadcasts:write` | Создание, изменение, запуск и остановка рассылок |
| `chains:read` | Чтение связок (цепочек автоматизации) и их блоков |
| `chains:write` | Создание, изменение, включение и удаление связок |
| `assistants:read` | Чтение ИИ-ассистентов и их настроек |
| `assistants:write` | Изменение ИИ-ассистентов: инструкции, модель, включение и пауза |
| `ai:read` | Чтение нейросетей, их моделей, базы знаний и журнала обращений |
| `ai:write` | Подключение нейросетей, правка базы знаний, разовые запросы к модели |
| `tasks:read` | Чтение задач CRM |
| `tasks:write` | Создание и изменение задач CRM |
| `webhooks:manage` | Подписка на события платформы: создание и настройка вебхуков |
| `account:read` | Чтение состояния рабочего пространства: баланс, тариф, лимиты, расход |

## Дальше

- Тела запросов, примеры на curl, JS, PHP и Python: [REST API v1](https://docs.tuk-tuk.online/api/rest).
- Те же возможности инструментами для нейросети: [Инструменты MCP](https://docs.tuk-tuk.online/api/mcp-tools).
- Готовые сценарии от ключа до первого ответа клиенту: [Сценарии для агента](https://docs.tuk-tuk.online/api/recipes).