1. Введение, JWT-аутентификация и интеграция

Base URL: https://<host>/api

Авторизация: Authorization: Bearer <access_token>

Auth endpoints

curl -X POST "https://host/api/auth/login" \
  -H "Content-Type: application/json" \
  -d '{"password":"***"}'

{"access_token":"ey...","refresh_token":"r...","user":{"email":"user@local"}}

{"refresh_token":"r..."}

{"access_token":"ey...","refresh_token":"r..."}

{"user":{"id":"...","email":"user@local"}}

Интеграция с внешней CRM в 4 шага

1. Авторизация (/api/auth/login) и получение JWT.
2. Создание/обновление кампании (/api/crm/campaigns) с ресурсами: prompt_resource_path, rag_db_name.
3. Импорт лидов (/api/crm/leads/import.csv) или пакетное создание лидов API.
4. Preflight и запуск: /preflight → /start.

2. CRM API (Лиды и кампании)

Лиды

curl -H "Authorization: Bearer ey..." "https://host/api/crm/leads?limit=100&offset=0&status=new"

{"phone_e164":"+971500000001","first_name":"Ivan","email":"ivan@crm.local","attributes":{"source":"amocrm","lead_list_name":"UAE_Q2"}}

{"status":"in_progress","attributes":{"priority":10}}

Импорт/экспорт лидов

POST /api/crm/leads/import.csv — multipart upload. Минимальные колонки: phone_e164 (или phone). Поддерживаются: first_name, last_name, email, status, lead_list_name, priority, timezone, kyc_status.

GET /api/crm/leads/export.csv — выгрузка текущего состояния лидов.

Кампании

{
  "name": "UAE Forex May",
  "status": "draft",
  "prompt_resource_path": "prompts/uae_forex_v3.txt",
  "rag_db_name": "uae_kb_main",
  "lead_list_names": ["UAE_Q2"],
  "target_lead_statuses": ["new", "in_progress"]
}

{"prompt_resource_path":"prompts/uae_forex_v4.txt","rag_db_name":"uae_kb_v2"}

Lifecycle Runtime

GET /api/crm/campaigns/{campaign_id}/preflight — проверка pod/service/provider readiness.

POST /api/crm/campaigns/{campaign_id}/start — создаёт CampaignRun и очередь CallTask.

POST /api/crm/campaigns/{campaign_id}/pause — переводит run в paused.

POST /api/crm/campaigns/{campaign_id}/stop — останавливает run и переводит активные задачи в terminal state.

3. Аналитика, звонки и webhook callback

GET /api/runtime/calls — активные/исторические звонки runtime (фильтры: status, campaign_id, only_active).

GET /api/crm/call-logs/export.csv — экспорт журнала звонков.

Webhook callback во внешнюю CRM (рекомендуемый контракт)

{
  "lead_id": "5f0b6f35-54a5-4f54-b835-9e43adfbe001",
  "campaign_id": "fcaef28d-07bb-4f14-8b4f-bfdaf6f61111",
  "duration_sec": 183,
  "call_status": "completed",
  "business_outcome": "connected",
  "customer_data": {
    "customer_name": "Alex Kim",
    "issue": "Просит расчёт доходности и условия вывода",
    "priority": "high",
    "ready_for_escalation": true
  },
  "transcript": "Agent: ... Customer: ..."
}

4. Управление ресурсами ИИ (Файлы и RAG)

Browser FS

GET /api/resources/files/tree, GET /api/resources/files/content, POST /api/resources/files/folder, POST /api/resources/files/file, PUT /api/resources/files/content, POST /api/resources/files/rename, DELETE /api/resources/files.

GET /api/resources/files/usage — защита от удаления ресурса, если он используется в активных кампаниях или RAG.

RAG Module

GET /api/resources/rag/capabilities — проверка доступности embedding runtime (RunPod pod).

POST /api/resources/rag/dbs/{db_name}/build — сборка векторной БД.

{
  "file_paths": ["kb/intro.md", "kb/faq.txt"],
  "overwrite": true
}

5. Инфраструктура и единая таблица ошибок

GET /api/pods, POST /api/pods/create, POST /api/pods/refresh, POST /api/pods/{pod_id}/delete.

GET /api/services, POST /api/services/{name}/start|stop|restart-hard.

GET /api/logs/tail.

Сводная таблица ошибок

Унифицированный блок ошибок для endpoint-ов

{
  "error": {
    "code": "service_unavailable",
    "message": "RunPod embedding runtime is not ready",
    "request_id": "req_01J...",
    "details": {"pod_state": "STARTING"}
  }
}

1. Introduction, JWT Authentication and Integration

Base URL: https://<host>/api

Authorization: Authorization: Bearer <access_token>

POST /api/auth/login, POST /api/auth/refresh, POST /api/auth/logout, GET /api/auth/me.

External CRM integration in 4 steps

1. Authenticate and get JWT tokens.
2. Create/update campaign with prompt_resource_path and rag_db_name.
3. Import leads via /api/crm/leads/import.csv or create via API.
4. Run /preflight and then /start.

2. CRM API (Leads and Campaigns)

GET /api/crm/leads supports pagination/filtering: limit, offset, status, campaign_id, q.

POST /api/crm/leads, PUT /api/crm/leads/{lead_id}, DELETE /api/crm/leads/{lead_id}.

CSV import/export: /api/crm/leads/import.csv, /api/crm/leads/export.csv.

POST /api/crm/campaigns, PUT /api/crm/campaigns/{campaign_id}, lifecycle: /preflight, /start, /pause, /stop.

3. Calls, Analytics and Webhook Callback

GET /api/runtime/calls and GET /api/crm/call-logs/export.csv.

Webhook payload (to external CRM)

{
  "lead_id": "uuid",
  "duration_sec": 183,
  "call_status": "completed",
  "business_outcome": "connected",
  "customer_data": {
    "customer_name": "Alex Kim",
    "issue": "Needs investment terms",
    "priority": "high",
    "ready_for_escalation": true
  },
  "transcript": "Agent: ... Customer: ..."
}

4. AI Resources (Files and RAG)

Browser FS endpoints: /tree, /content, /folder, /file, /rename, /delete, /usage.

RAG endpoints: /api/resources/rag/dbs, /api/resources/rag/capabilities, /api/resources/rag/dbs/{db_name}/build.

5. Infrastructure and Error Codes

Pods: /api/pods, /api/pods/create, /api/pods/refresh, /api/pods/{pod_id}/delete.

Services: /api/services, /api/services/{name}/start|stop|restart-hard.