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

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

Кратко
Открыть .mdСпросить ChatGPTСпросить Claude

Полный справочник публичного 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.
REST API v1Инструменты MCPСценарии для агентаДля нейросетей и MCPEvent Webhooks
На этой странице

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

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

#Ресурсы

РесурсЭндпоинтовЧто внутри
Ключ и рабочее пространство5Кто мы, что разрешено ключу, сколько денег и лимитов осталось.
Каналы связи1Подключённые мессенджеры, почта, SMS-шлюз и чат-виджет. Секреты каналов не отдаются.
Контакты6Карточки клиентов: поиск, создание, теги, произвольные поля, статусы, заметки.
Сообщения4Отправка в любой подключённый канал, включая отложенную на конкретное время.
Файлы3Постоянное хранилище вложений: ссылка не протухнет, своего хостинга не нужно.
Рассылки14Сегмент клиентов, темп отправки, окно по времени, отчёт по каждому получателю.
Связки10Автоматические сценарии на входящее сообщение: ветвления, задержки, ИИ, вебхуки, код.
Воронки автопостинга14Сторис и посты по расписанию, в том числе зациклённые. Схема из блоков.
ИИ-ассистенты10Кто отвечает клиентам автоматически. Паузу в конкретном диалоге можно забрать себе.
Нейросети16Какие модели существуют, что подключено у клиента, чем ассистент может пользоваться.
Задачи5Задачи CRM: статус, приоритет, исполнитель, дедлайн, привязка к контакту.
События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/emailcontacts:read
POST/api/v1/contactsСоздать карточку клиентаcontacts:write
GET/api/v1/contacts/{id}Карточка по IDcontacts: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Забрать файл по ссылке в хранилище и получить постоянный URLfiles: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Чтение состояния рабочего пространства: баланс, тариф, лимиты, расход

#Дальше