API-пайплайн: получить бесплатный 7-дневный стартовый радар для своего проекта и смотреть его совпадения
Индекс: API-пайплайны — индекс
Цель: человек со страницей проекта на Cabi.Chat получает бесплатный 7-дневный радар для этого проекта и смотрит его совпадения.
Что получает человек
- Радар, который Cabi.Chat ведёт для его проекта, бесплатно 7 дней. Он находит публичные сообщения в Telegram-группах, где люди ищут то, что предлагает проект, и собирает их как совпадения.
- Радар никому не пишет: человек сам решает, с кем связаться.
- Две ссылки, уже принятые для человека на его проект: trial (управлять: запуск / остановка, правка ключевых слов; 7 дней) и view (читать радар и его совпадения; без срока).
- Через 7 дней радар встаёт на паузу; совпадения остаются доступными для чтения. Держать радар запущенным — это шаг Pro: API-пайплайн: слушать Telegram-группы и находить людей, которым вы нужны: создать и настроить радар, работать с его совпадениями и выходить на первый контакт (черновик, отправка, автоматический outreach)
Кто вызывает
Владелец проекта: своей сессией или PAT, либо через оракула Cabi.Chat, которому он дал доступ на настройку. Один стартовый радар на человека.
Шаги
1. Открыть. Тело необязательно: без него ключевые слова берутся из рубрик или названия проекта и его города.
POST /v0/my/projects/470000000000000020/starter-radar
{"keywords": [["dentist", "dental clinic"]], "not_groups": ["vacancy"], "city": "bali"}
→ {"campaign": "470000000000000021", "matches_workspace": "470000000000000022",
"links": {"trial": {"nonce": "…", "token": "…", "url": "https://cabi.chat/l/…"},
"view": {"nonce": "…", "token": "…", "url": "https://cabi.chat/l/…"}},
"trial_ends_at": "2026-10-22T…Z", "status": "Active", "is_active": true,
"keyword_groups": [["dentist", "dental clinic"], ["bali"]], "not_groups": [["vacancy"]], "created": true}
keywords: группы (OR внутри группы, AND между группами), включая город; слова от 4 букв; приводятся к нижнему регистру и нормализуются.not_groups: слова от 2 букв, плоским списком или группами.- Повторный вызов для того же проекта возвращает тот же радар (
created: false, тело игнорируется).
2. Читать совпадения.
GET /v0/my/workspaces/470000000000000022?contained_limit=200
→ {"contained": [{"card_type": "post", "nonce": "…", "snippet": "…", "source_url": "https://t.me/example_group/123", …}], …}
3. Подстроить во время пробного периода. PATCH /v0/my/campaigns/470000000000000021 {"keyword_groups": [[…]], "not_groups": [[…]]} и POST …/start / …/stop. Остальные поля задаёт Cabi.Chat.
Правила
- Проект не ваш → 404. Другой ваш стартовый радар на другом проекте → 409
… one starter radar per person. Стартовые радары иногда могут быть недоступны → 400starter radars are not available right now. - Ошибки ключевых слов → 400 с причиной (
keywords hold no usable word (4+ letters),could not derive keywords from the project …: pass keywords). - Закончившийся пробный период повторным вызовом не перезапускается.
Поверхность API
| Эндпоинт | Назначение | FE | ИИ / оракул |
|---|---|---|---|
POST /v0/my/projects/{nonce}/starter-radar |
Открыть (или вернуть) стартовый радар проекта | нет | собственный ИИ владельца или оракул Cabi.Chat с доступом на настройку |
GET /v0/my/workspaces/{matches_workspace} |
Читать совпадения | да | да |
PATCH /v0/my/campaigns/{nonce} |
Ключевые слова и исключения во время пробного периода | да | да |
POST /v0/my/campaigns/{nonce}/start, /stop |
Запуск / пауза во время пробного периода | да | да |
GET /v0/linked/{token}?project= |
Принять ссылку на другой свой проект | да | собственный ИИ пользователя |