Документація REST API v1 & Model Context Protocol (MCP)
Керуйте брендами, генеруйте дописи за допомогою ШІ, плануйте публікації на 15 платформах та підключайте OperPilot до Claude Desktop, Cursor AI або Make.com.
Базова URL-адреса робочого API:
Автентифікація (API Key)
Усі запити потребують секретного ключа API, переданого у заголовку Authorization як Bearer токен. Ключі створюються в кабінеті користувача.
Ліміти запитів (Rate Limits)
Стандартний ліміт — 60 запитів на хвилину на один ключ API. При перевищенні повертається статус 429 Too Many Requests.
Model Context Protocol (MCP)
Підключіть OperPilot безпосередньо до Claude Desktop, Cursor AI або будь-якого клієнта MCP для надання ШІ доступу до 12 інструментів публікації.
Конфігурація у Claude Desktop
{
"mcpServers": {
"operpilot": {
"command": "node",
"args": ["-e", "fetch('https://app.operpilot.com/operpilot-mcp.mjs').then(r=>r.text()).then(eval)"],
"env": {
"OPERPILOT_API_KEY": "op_live_YOUR_API_KEY"
}
}
}
}Конфігурація у Cursor AI (.cursor/mcp.json)
{
"mcpServers": {
"operpilot": {
"command": "node",
"args": ["-e", "fetch('https://app.operpilot.com/operpilot-mcp.mjs').then(r=>r.text()).then(eval)"],
"env": {
"OPERPILOT_API_KEY": "op_live_YOUR_API_KEY"
}
}
}
}12 інструментів MCP OperPilot
Після підключення MCP сервера ваш ШІ-асистент отримує прямий доступ до наступних 12 функцій за допомогою природних команд.
get_profile
ДНК вашого бренду: профіль компанії, галузь, цільова аудиторія, стиль комунікації (Brand Voice) та візуальні орієнтири для ШІ.
connected_accounts
Активні канали публікації: повний перелік підключених соціальних профілів (з 15 платформ), готових до негайної або запланованої публікації.
generate_post
ШІ-генератор дописів: створює влучний текст з хештегами будь-якою з 7 мов (PL, EN, DE, ES, FR, IT, UK) відповідно до стилю вашого бренду.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| topic | string | Обов'язковий | Тема, мета або ключове повідомлення. |
| language | string | Необов'язковий | Код мови ('pl', 'en', 'de', 'es', 'fr', 'it', 'uk'). |
| platform | string | Необов'язковий | Цільова платформа (наприклад, 'linkedin', 'facebook'). |
| tone | string | Необов'язковий | Стиль подачі (наприклад, 'експертний', 'розмовний'). |
generate_ideas
Генератор тем та ідей: пропонує свіжі концепції публікацій, адаптовані до вашої ніші.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| topic | string | Необов'язковий | Тематика або напрямок кампанії. |
| locale | string | Необов'язковий | Мова ідей ('pl', 'en', 'de', 'es', 'fr', 'it', 'uk'). |
translate_post
Мультимовна адаптація: перекладає та локалізує допис для 7 європейських ринків зі збереженням Brand Voice.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| text | string | Обов'язковий | Текст допису для перекладу. |
| target_language | string | Обов'язковий | Цільова мова ('pl', 'en', 'de', 'es', 'fr', 'it', 'uk'). |
create_post
Реєстрація допису: створює публікацію в OperPilot, призначає платформи та планує час виходу або публікує миттєво.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| title | string | Обов'язковий | Робоча назва допису. |
| content | string | Обов'язковий | Повний текст допису з хештегами. |
| platforms | array | Необов'язковий | Перелік платформ (наприклад, ['facebook', 'linkedin']). |
| scheduled_at | string | Необов'язковий | Час публікації у форматі ISO. Порожньо = чернетка. |
| publish_now | boolean | Необов'язковий | True — опублікувати негайно. |
list_posts
Реєстр публікацій: перегляд дописів з фільтрацією за статусом (draft, scheduled, published, failed).
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| status | string | Необов'язковий | Фільтр статусу ('draft', 'scheduled', 'published', 'failed'). |
| limit | number | Необов'язковий | Максимальна кількість (за замовчуванням 20, макс 50). |
schedule_post
Планувальник: змінює або призначає дату та час виходу існуючого допису.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| post_id | string | Обов'язковий | Ідентифікатор допису (UUID). |
| scheduled_at | string | Обов'язковий | Новий час у форматі ISO. |
publish_post
Миттєва публікація: відправляє створений допис на всі призначені канали прямо зараз.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| post_id | string | Обов'язковий | Ідентифікатор допису (UUID). |
delete_post
Видалення: безповоротно видаляє допис та скасовує чергу відправки.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| post_id | string | Обов'язковий | Ідентифікатор допису (UUID). |
analytics
Аналітичний центр: статистика переглядів, вподобань, коментарів та взаємодій за платформами.
list_brands
Керування брендами: перелік брендів/клієнтів у робочому просторі (для тарифів Pro та Business).
Довідник REST API v1
Для прямої інтеграції через HTTP з власними бекенд-системами, скриптами або no-code платформами (Make.com, n8n, Zapier).
https://app.operpilot.com/api/v1/profile
Повертає повні настанови бренду: назву, галузь, опис діяльності, цільову аудиторію, стиль комунікації та колірну палітру.
curl -X GET "https://app.operpilot.com/api/v1/profile" \
-H "Authorization: Bearer op_live_YOUR_API_KEY" \
-H "Accept: application/json"{
"profile": {
"name": "Acme Software",
"description": "Platforma automatyzacji AI dla e-commerce i marketingu B2B.",
"industry": "Software / B2B SaaS",
"targetAudience": "Właściciele sklepów internetowych, menedżerowie marketingu",
"brandVoice": "Profesjonalny, oparty na faktach, technologiczny",
"website": "https://example.com"
}
}/channels
Повертає підключені акаунти з 15 підтримуваних мереж (Facebook, Instagram, LinkedIn, Google Business, YouTube тощо).
curl -X GET "https://app.operpilot.com/api/v1/channels" \
-H "Authorization: Bearer op_live_YOUR_API_KEY" \
-H "Accept: application/json"{
"channels": [
{
"id": "conn_91f8a2b3",
"platform": "facebook",
"name": "Acme Fanpage",
"isConnected": true
},
{
"id": "conn_44c21e7d",
"platform": "linkedin",
"name": "Acme Corporate",
"isConnected": true
}
]
}/posts
Повертає список дописів з фільтрацією за статусом (draft, scheduled, published, failed).
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| status | string (query) | Необов'язковий | Фільтр статусу ('draft', 'scheduled', 'published', 'failed'). |
| limit | number (query) | Необов'язковий | Ліміт записів (макс 50). |
curl -X GET "https://app.operpilot.com/api/v1/posts" \
-H "Authorization: Bearer op_live_YOUR_API_KEY" \
-H "Accept: application/json"{
"posts": [
{
"id": "c7a84e12-4215-4ff1-a8bc-19b841e42109",
"title": "Nowości w ofercie",
"status": "scheduled",
"scheduledAt": "2026-10-25T14:00:00.000Z",
"platforms": ["facebook", "linkedin"]
}
]
}/posts
Створює допис у базі, прив'язує канали та за бажанням планує дату або публікує миттєво.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| title | string | Обов'язковий | Заголовок або робоча назва. |
| content | string | Обов'язковий | Повний текст допису з хештегами. |
| platforms | array | Необов'язковий | Список платформ. |
| scheduled_at | string | Необов'язковий | Час ISO для планування. |
| publish_now | boolean | Необов'язковий | True — публікувати негайно. |
curl -X POST "https://app.operpilot.com/api/v1/posts" \
-H "Authorization: Bearer op_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Nowy post z API",
"content": "Właśnie publikujemy ten wpis automatycznie przez OperPilot REST API v1 🚀",
"platforms": ["facebook", "linkedin"],
"publish_now": true
}'{
"success": true,
"post": {
"id": "c7a84e12-4215-4ff1-a8bc-19b841e42109",
"title": "Nowy post z API",
"status": "scheduled",
"scheduledAt": "2026-10-25T14:00:00.000Z",
"platforms": ["facebook", "linkedin"]
}
}/posts/:id
Повертає детальний об'єкт допису з ідентифікаторами віддалених публікацій у соцмережах.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| id | string (path) | Обов'язковий | Ідентифікатор допису (UUID). |
curl -X GET "https://app.operpilot.com/api/v1/posts/c7a84e12-4215-4ff1-a8bc-19b841e42109" \
-H "Authorization: Bearer op_live_YOUR_API_KEY" \
-H "Accept: application/json"{
"post": {
"id": "c7a84e12-4215-4ff1-a8bc-19b841e42109",
"title": "Jak automatyzacja oszczędza czas?",
"status": "published",
"targets": [
{ "platform": "facebook", "status": "published", "remotePostId": "fb_123456" },
{ "platform": "linkedin", "status": "published", "remotePostId": "urn:li:share:789" }
]
}
}/posts/:id
Дозволяє редагувати текст, заголовок або переносити запланований час виходу.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| id | string (path) | Обов'язковий | Ідентифікатор допису (UUID). |
| title | string | Необов'язковий | Новий заголовок. |
| content | string | Необов'язковий | Новий текст. |
| scheduled_at | string | Необов'язковий | Новий час ISO. |
curl -X PATCH "https://app.operpilot.com/api/v1/posts/c7a84e12-4215-4ff1-a8bc-19b841e42109" \
-H "Authorization: Bearer op_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"scheduled_at": "2026-10-25T16:00:00.000Z"
}'{
"success": true,
"post": {
"id": "c7a84e12-4215-4ff1-a8bc-19b841e42109",
"status": "scheduled",
"scheduledAt": "2026-10-25T16:00:00.000Z"
}
}/posts/:id
Незворотно видаляє допис та скасовує завдання у черзі відправки.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| id | string (path) | Обов'язковий | Ідентифікатор допису (UUID). |
curl -X DELETE "https://app.operpilot.com/api/v1/posts/c7a84e12-4215-4ff1-a8bc-19b841e42109" \
-H "Authorization: Bearer op_live_YOUR_API_KEY"{
"success": true,
"message": "Post został pomyślnie usunięty."
}/analytics
Повертає підсумок переглядів, залучення, лайків та коментарів за кожною платформою.
curl -X GET "https://app.operpilot.com/api/v1/analytics" \
-H "Authorization: Bearer op_live_YOUR_API_KEY" \
-H "Accept: application/json"{
"analytics": {
"totalImpressions": 24500,
"totalEngagements": 1820,
"totalLikes": 1240,
"totalComments": 185,
"totalShares": 95,
"byPlatform": {
"facebook": { "impressions": 12000, "engagements": 920 },
"linkedin": { "impressions": 8500, "engagements": 650 },
"instagram": { "impressions": 4000, "engagements": 250 }
}
}
}/brands
Повертає перелік усіх брендів/клієнтів у робочому просторі (для пакетів Pro та Business).
curl -X GET "https://app.operpilot.com/api/v1/brands" \
-H "Authorization: Bearer op_live_YOUR_API_KEY" \
-H "Accept: application/json"{
"brands": [
{
"id": "brand_01a",
"name": "Acme Software",
"industry": "IT & Automation",
"isDefault": true
}
]
}ШІ-двигун на 7 мовах (Генерація, Ідеї, Переклад)
Вбудовані ендпоінти штучного інтелекту, оптимізовані для копірайтингу та локалізації під 12 соціальних мереж з дотриманням Brand Voice.
/ai/generate
Генерує допис відповідно до стилю бренду (Brand Voice) будь-якою з 7 мов (PL, EN, DE, ES, FR, IT, UK) разом з хештегами.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| topic | string | Обов'язковий | Тема, мета або ключове повідомлення. |
| language | string | Необов'язковий | Код мови ('pl', 'en', 'de', 'es', 'fr', 'it', 'uk'). |
| platform | string | Необов'язковий | Платформа (наприклад, 'linkedin', 'facebook'). |
| tone | string | Необов'язковий | Стиль (наприклад, 'експертний'). |
curl -X POST "https://app.operpilot.com/api/v1/ai/generate" \
-H "Authorization: Bearer op_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"topic": "Wprowadzenie automatyzacji social media w firmie",
"language": "uk",
"platform": "linkedin",
"tone": "expert"
}'{
"content": "Czy wiesz, że regularność w publikacji to klucz do algorytmów social media? 🚀\n\nOto 3 kroki, jak zautomatyzować publikacje bez utraty jakości...",
"hashtags": ["#marketing", "#automatyzacja", "#socialmedia", "#productivity"],
"language": "pl",
"characterCount": 420
}/ai/ideas
Формує набір пропозицій дописів, влучних заголовків та форматів для вашої цільової аудиторії.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| topic | string | Необов'язковий | Тема або мотив кампанії. |
| locale | string | Необов'язковий | Мова ідей ('pl', 'en', 'de', 'es', 'fr', 'it', 'uk'). |
curl -X POST "https://app.operpilot.com/api/v1/ai/ideas" \
-H "Authorization: Bearer op_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"topic": "Marketing tips",
"locale": "uk"
}'{
"ideas": [
{
"title": "5 błędów w planowaniu postów, które obcinają zasięg",
"angle": "Post edukacyjny / checklista",
"targetFormat": "Karuzela lub wątek",
"hook": "Robisz to co tydzień? Algorytmy tego nie lubią..."
}
]
}/ai/translate
Перекладає допис на будь-яку з 7 мов з урахуванням регіональної специфіки, ідіом та стилю бренду.
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
| text | string | Обов'язковий | Текст для перекладу. |
| target_language | string | Обов'язковий | Цільова мова ('pl', 'en', 'de', 'es', 'fr', 'it', 'uk'). |
curl -X POST "https://app.operpilot.com/api/v1/ai/translate" \
-H "Authorization: Bearer op_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"text": "Nasz nowy produkt jest już dostępny w sprzedaży!",
"target_language": "de"
}'{
"translatedText": "Did you know that consistency is the #1 factor in social media reach? 🚀\n\nHere are 3 ways to automate your schedule while keeping human touch...",
"targetLanguage": "en"
}Коди помилок та ліміти запитів
OperPilot API використовує стандартні коди HTTP відповідей зі зрозумілими повідомленнями JSON.
| Код HTTP | Назва | Значення та вирішення |
|---|---|---|
| 200 OK | Success | Запит виконано успішно. |
| 201 Created | Created | Ресурс (наприклад, новий допис) успішно створено. |
| 400 Bad Request | Invalid Request | Відсутні обов'язкові поля або некоректні дані (наприклад, немає 'title' чи 'content'). |
| 401 Unauthorized | Unauthorized | Відсутній або недійсний ключ API у заголовку Authorization: Bearer. |
| 403 Forbidden | Forbidden | Ключ API анульовано або він не має прав на виконання цієї операції. |
| 404 Not Found | Not Found | Вказаний допис або ресурс не знайдено. |
| 429 Too Many Requests | Rate Limited | Перевищено ліміт запитів (60 запитів/хвилину). Зачекайте перед повторною спробою. |
| 500 Internal Error | Server Error | Неочікувана помилка сервера. Зверніться до підтримки: kontakt@operpilot.com. |
No-Code автоматизація (Make.com, Zapier, n8n)
Підключайте OperPilot до сценаріїв Make.com або Zapier за допомогою стандартного HTTP модуля:
Кроки налаштування в Make.com:
- Додайте модуль HTTP -> Make a request.
- Вкажіть URL: https://app.operpilot.com/api/v1/posts та Method: POST.
- У Headers вкажіть: Authorization = Bearer op_live_ВАШ_КЛЮЧ та Content-Type = application/json.
- У Body Type оберіть Raw -> JSON та передайте параметри title, content, platforms і publish_now.