{ "openapi": "3.1.0", "info": { "title": "Volara API", "version": "1.0.0", "description": "REST API Volara — CRM omnichannel untuk WhatsApp, Instagram, dan TikTok. Autentikasi dengan API key via header `Authorization: Bearer ` (atau `x-api-key`). Base URL `https://api.volara.chat`; `/api/v1/*` mirror dari `/api/*`. Lihat panduan konsep: Autentikasi, Errors, Rate Limits, Pagination, Webhooks." }, "servers": [ { "url": "https://api.volara.chat", "description": "Production" } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "tags": [ { "name": "System", "description": "Service metadata & health" }, { "name": "Admin", "description": "Operasi admin organisasi" }, { "name": "User", "description": "Manajemen user & tim" }, { "name": "API Tools", "description": "Tooling untuk integrasi developer" }, { "name": "Compatibility", "description": "Endpoint kompatibilitas" }, { "name": "AI", "description": "AI & balasan otomatis" }, { "name": "Authority", "description": "Autentikasi & otorisasi" }, { "name": "Advanced", "description": "Endpoint lanjutan" }, { "name": "Billing", "description": "Penagihan & langganan" }, { "name": "Broadcast", "description": "Kampanye broadcast" }, { "name": "Business Webhooks", "description": "Webhook bisnis (outbound)" }, { "name": "Message", "description": "Pengiriman & penerimaan pesan" }, { "name": "Chatbot", "description": "Konfigurasi AI chatbot" }, { "name": "Contact", "description": "Manajemen kontak" }, { "name": "Conversation", "description": "Manajemen percakapan" }, { "name": "CRM", "description": "CRM & pipeline" }, { "name": "Customer", "description": "Data pelanggan" }, { "name": "Developer Keys", "description": "API key developer" }, { "name": "Flow", "description": "Automation flows" }, { "name": "Inbox", "description": "Inbox omnichannel" }, { "name": "Instagram", "description": "Channel Instagram" }, { "name": "Knowledge", "description": "Knowledge base / RAG" }, { "name": "Label", "description": "Label percakapan" }, { "name": "Media", "description": "Upload & media" }, { "name": "Orders", "description": "Pesanan" }, { "name": "Organization", "description": "Organisasi / tenant" }, { "name": "Super Admin", "description": "Operasi super admin" }, { "name": "Team", "description": "Manajemen tim" }, { "name": "Template Variables", "description": "Variabel template" }, { "name": "WhatsApp", "description": "Channel WhatsApp (WABA)" }, { "name": "Tickets", "description": "Tiket support" }, { "name": "TikTok", "description": "Channel TikTok" }, { "name": "WABA", "description": "WhatsApp Business Account" }, { "name": "Webhook", "description": "Webhook" }, { "name": "Volara Compatibility", "description": "Kompatibilitas Volara" }, { "name": "Better Auth", "description": "Better Auth (autentikasi)" } ], "paths": { "/": { "get": { "tags": [ "System" ], "summary": "Service metadata", "operationId": "get_", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } } } }, "/api/admin/apps": { "get": { "tags": [ "Admin" ], "summary": "GET /apps", "operationId": "get_api_admin_apps", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/apps/{id}": { "get": { "tags": [ "Admin" ], "summary": "GET /apps/:id", "operationId": "get_api_admin_apps_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/apps/{id}/status": { "patch": { "tags": [ "Admin" ], "summary": "PATCH /apps/:id/status", "operationId": "patch_api_admin_apps_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "isActive": { "type": "boolean", "example": true } }, "required": [ "isActive" ] }, "example": { "isActive": true } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/apps/{id}/top-up": { "post": { "tags": [ "Admin" ], "summary": "POST /apps/:id/top-up", "operationId": "post_api_admin_apps_id_top_up", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "example": 0 }, "reason": { "type": "string", "example": "string" } }, "required": [ "amount" ] }, "example": { "amount": 0, "reason": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/billing/organizations": { "get": { "tags": [ "Admin" ], "summary": "GET /billing/organizations", "operationId": "get_api_admin_billing_organizations", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/billing/organizations/{id}/balance": { "get": { "tags": [ "Admin" ], "summary": "GET /billing/organizations/:id/balance", "operationId": "get_api_admin_billing_organizations_id_balance", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/billing/organizations/{id}/credits": { "post": { "tags": [ "Admin" ], "summary": "POST /billing/organizations/:id/credits", "operationId": "post_api_admin_billing_organizations_id_credits", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "example": 0 }, "reason": { "type": "string", "example": "string" }, "adminId": { "type": "string", "example": "string" } }, "required": [ "amount" ] }, "example": { "amount": 0, "reason": "string", "adminId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/billing/organizations/{id}/transactions": { "get": { "tags": [ "Admin" ], "summary": "GET /billing/organizations/:id/transactions", "operationId": "get_api_admin_billing_organizations_id_transactions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/billing/payment-requests": { "get": { "tags": [ "Admin" ], "summary": "GET /billing/payment-requests", "operationId": "get_api_admin_billing_payment_requests", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/billing/payment-requests/{id}": { "get": { "tags": [ "Admin" ], "summary": "GET /billing/payment-requests/:id", "operationId": "get_api_admin_billing_payment_requests_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/billing/pricing": { "get": { "tags": [ "Admin" ], "summary": "GET /billing/pricing", "operationId": "get_api_admin_billing_pricing", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Admin" ], "summary": "POST /billing/pricing", "operationId": "post_api_admin_billing_pricing", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "modelName": { "type": "string", "example": "string" }, "costPerRequest": { "type": "number", "example": 0 }, "description": { "type": "string", "example": "string" } }, "required": [ "modelName", "costPerRequest" ] }, "example": { "modelName": "string", "costPerRequest": 0, "description": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/billing/pricing/{id}": { "delete": { "tags": [ "Admin" ], "summary": "DELETE /billing/pricing/:id", "operationId": "delete_api_admin_billing_pricing_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "Admin" ], "summary": "PUT /billing/pricing/:id", "operationId": "put_api_admin_billing_pricing_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "costPerRequest": { "type": "number", "example": 0 }, "description": { "type": "string", "example": "string" }, "isActive": { "type": "boolean", "example": true } }, "required": [ "costPerRequest" ] }, "example": { "costPerRequest": 0, "description": "string", "isActive": true } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/members": { "get": { "tags": [ "Admin" ], "summary": "GET /members", "operationId": "get_api_admin_members", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/members/{id}/role": { "patch": { "tags": [ "Admin" ], "summary": "PATCH /members/:id/role", "operationId": "patch_api_admin_members_id_role", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "example": "string" } }, "required": [ "role" ] }, "example": { "role": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/organizations": { "get": { "tags": [ "Admin" ], "summary": "GET /organizations", "operationId": "get_api_admin_organizations", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/queues/{name}/retry": { "post": { "tags": [ "Admin" ], "summary": "POST /queues/:name/retry", "operationId": "post_api_admin_queues_name_retry", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/queues/stats": { "get": { "tags": [ "Admin" ], "summary": "GET /queues/stats", "operationId": "get_api_admin_queues_stats", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/stats": { "get": { "tags": [ "Admin" ], "summary": "GET /stats", "operationId": "get_api_admin_stats", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/subscriptions": { "get": { "tags": [ "Admin" ], "summary": "GET /subscriptions", "operationId": "get_api_admin_subscriptions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/subscriptions/{id}": { "get": { "tags": [ "Admin" ], "summary": "GET /subscriptions/:id", "operationId": "get_api_admin_subscriptions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Admin" ], "summary": "PATCH /subscriptions/:id", "operationId": "patch_api_admin_subscriptions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "string" }, "subscriptionType": { "type": "string", "example": "string" }, "itemName": { "type": "string", "example": "string" }, "billingAmount": { "type": "number", "example": 0 }, "cycles": { "type": "number", "example": 0 }, "startDate": { "type": "string", "example": "string" }, "nextBilling": { "type": "string", "example": "string" }, "endDate": { "type": "string", "example": "string" } } }, "example": { "status": "string", "subscriptionType": "string", "itemName": "string", "billingAmount": 0, "cycles": 0, "startDate": "string", "nextBilling": "string", "endDate": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/usage/summary": { "get": { "tags": [ "Admin" ], "summary": "GET /usage/summary", "operationId": "get_api_admin_usage_summary", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/users/{id}/suspend": { "post": { "tags": [ "Admin" ], "summary": "POST /users/:id/suspend", "operationId": "post_api_admin_users_id_suspend", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/users/{id}/unsuspend": { "post": { "tags": [ "Admin" ], "summary": "POST /users/:id/unsuspend", "operationId": "post_api_admin_users_id_unsuspend", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/webhook-events": { "get": { "tags": [ "Admin" ], "summary": "GET /webhook-events", "operationId": "get_api_admin_webhook_events", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/webhook-events/{id}": { "get": { "tags": [ "Admin" ], "summary": "GET /webhook-events/:id", "operationId": "get_api_admin_webhook_events_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/xendit/settings": { "get": { "tags": [ "Admin" ], "summary": "GET /xendit/settings", "operationId": "get_api_admin_xendit_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "Admin" ], "summary": "PUT /xendit/settings", "operationId": "put_api_admin_xendit_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "reconciliationEnabled": { "type": "boolean", "example": true }, "secretKey": { "type": "string", "example": "string" }, "callbackToken": { "type": "string", "example": "string" }, "clearSecretKey": { "type": "boolean", "example": true }, "clearCallbackToken": { "type": "boolean", "example": true } } }, "example": { "enabled": true, "reconciliationEnabled": true, "secretKey": "string", "callbackToken": "string", "clearSecretKey": true, "clearCallbackToken": true } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/admin/xendit/test": { "post": { "tags": [ "Admin" ], "summary": "POST /xendit/test", "operationId": "post_api_admin_xendit_test", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/agent-settings": { "get": { "tags": [ "Admin" ], "summary": "GET /", "operationId": "get_api_agent_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "Admin" ], "summary": "PUT /", "operationId": "put_api_agent_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/agents": { "get": { "tags": [ "User" ], "summary": "GET /", "operationId": "get_api_agents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "User" ], "summary": "POST /", "operationId": "post_api_agents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/agents-management": { "get": { "tags": [ "User" ], "summary": "GET /", "operationId": "get_api_agents_management", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "User" ], "summary": "POST /", "operationId": "post_api_agents_management", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/agents-management/{id}": { "delete": { "tags": [ "User" ], "summary": "DELETE /:id", "operationId": "delete_api_agents_management_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "User" ], "summary": "PATCH /:id", "operationId": "patch_api_agents_management_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "User" ], "summary": "PUT /:id", "operationId": "put_api_agents_management_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/agents-management/divisions": { "get": { "tags": [ "User" ], "summary": "Divisions", "operationId": "get_api_agents_management_divisions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "User" ], "summary": "POST /divisions", "operationId": "post_api_agents_management_divisions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "string" }, "color": { "type": "string", "example": "string" } }, "required": [ "name" ] }, "example": { "name": "string", "description": "string", "color": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/agents-management/divisions/{id}": { "delete": { "tags": [ "User" ], "summary": "DELETE /divisions/:id", "operationId": "delete_api_agents_management_divisions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "User" ], "summary": "PUT /divisions/:id", "operationId": "put_api_agents_management_divisions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "string" }, "color": { "type": "string", "example": "string" }, "parent_division_id": { "type": "string", "example": "string" } } }, "example": { "name": "string", "description": "string", "color": "string", "parent_division_id": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/agents-management/login-link": { "get": { "tags": [ "User" ], "summary": "GET /login-link", "operationId": "get_api_agents_management_login_link", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/agents/{id}": { "delete": { "tags": [ "User" ], "summary": "DELETE /:id", "operationId": "delete_api_agents_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "User" ], "summary": "PATCH /:id", "operationId": "patch_api_agents_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "User" ], "summary": "PUT /:id", "operationId": "put_api_agents_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/agents/divisions": { "get": { "tags": [ "User" ], "summary": "Divisions", "operationId": "get_api_agents_divisions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "User" ], "summary": "POST /divisions", "operationId": "post_api_agents_divisions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "string" }, "color": { "type": "string", "example": "string" } }, "required": [ "name" ] }, "example": { "name": "string", "description": "string", "color": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/agents/divisions/{id}": { "delete": { "tags": [ "User" ], "summary": "DELETE /divisions/:id", "operationId": "delete_api_agents_divisions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "User" ], "summary": "PUT /divisions/:id", "operationId": "put_api_agents_divisions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "string" }, "color": { "type": "string", "example": "string" }, "parent_division_id": { "type": "string", "example": "string" } } }, "example": { "name": "string", "description": "string", "color": "string", "parent_division_id": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/agents/login-link": { "get": { "tags": [ "User" ], "summary": "GET /login-link", "operationId": "get_api_agents_login_link", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai_tools": { "get": { "tags": [ "API Tools" ], "summary": "GET /", "operationId": "get_api_ai_tools", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "API Tools" ], "summary": "POST /", "operationId": "post_api_ai_tools", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "API Tools" ], "summary": "PUT /", "operationId": "put_api_ai_tools", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai_tools/{id}": { "delete": { "tags": [ "API Tools" ], "summary": "DELETE /:id", "operationId": "delete_api_ai_tools_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "API Tools" ], "summary": "PATCH /:id", "operationId": "patch_api_ai_tools_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai_tools/execute": { "post": { "tags": [ "API Tools" ], "summary": "POST /execute", "operationId": "post_api_ai_tools_execute", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai-providers": { "get": { "tags": [ "Compatibility" ], "summary": "List configured AI providers", "operationId": "get_api_ai_providers", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai-providers/{provider}": { "put": { "tags": [ "Compatibility" ], "summary": "Upsert provider configuration", "operationId": "put_api_ai_providers_provider", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "example": "openai" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "api_key": { "type": "string", "example": "sk-..." }, "base_url": { "type": "string", "example": "https://api.openai.com/v1" }, "model_name": { "type": "string", "example": "gpt-4o-mini" } } }, "example": { "api_key": "sk-...", "base_url": "https://api.openai.com/v1", "model_name": "gpt-4o-mini" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai-providers/active": { "patch": { "tags": [ "Compatibility" ], "summary": "Set active AI provider", "operationId": "patch_api_ai_providers_active", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "type": "string", "example": "openai" } }, "required": [ "provider" ] }, "example": { "provider": "openai" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai-settings": { "get": { "tags": [ "Compatibility" ], "summary": "Compatibility endpoint for AI settings", "operationId": "get_api_ai_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "org-slug-or-app-id" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "Compatibility" ], "summary": "Update AI settings compatibility endpoint", "operationId": "put_api_ai_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "model_provider": { "type": "string", "example": "openai" }, "model_name": { "type": "string", "example": "gpt-4o-mini" }, "temperature": { "type": "number", "example": 0.7 }, "max_tokens": { "type": "number", "example": 500 } } }, "example": { "model_provider": "openai", "model_name": "gpt-4o-mini", "temperature": 0.7, "max_tokens": 500 } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai/evaluate": { "post": { "tags": [ "AI" ], "summary": "POST /evaluate", "operationId": "post_api_ai_evaluate", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "appId": { "type": "string", "example": "string" }, "conversationId": { "type": "string", "example": "string" }, "score": { "type": "number", "example": 0 }, "feedback": { "type": "string", "example": "string" } }, "required": [ "conversationId", "score" ] }, "example": { "appId": "string", "conversationId": "string", "score": 0, "feedback": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai/generate": { "post": { "tags": [ "AI" ], "summary": "POST /generate", "operationId": "post_api_ai_generate", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "string" }, "conversationId": { "type": "string", "example": "string" } }, "required": [ "message" ] }, "example": { "message": "string", "conversationId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai/providers": { "get": { "tags": [ "AI" ], "summary": "GET /providers", "operationId": "get_api_ai_providers", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai/providers/{provider}": { "put": { "tags": [ "AI" ], "summary": "PUT /providers/:provider", "operationId": "put_api_ai_providers_provider", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "example": "growthcircle" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai/providers/active": { "patch": { "tags": [ "AI" ], "summary": "PATCH /providers/active", "operationId": "patch_api_ai_providers_active", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai/settings": { "get": { "tags": [ "AI" ], "summary": "GET /settings", "operationId": "get_api_ai_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "AI" ], "summary": "PATCH /settings", "operationId": "patch_api_ai_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/ai/suggest/{conversationId}": { "get": { "tags": [ "AI" ], "summary": "GET /suggest/:conversationId", "operationId": "get_api_ai_suggest_conversationId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/app-center/apps": { "get": { "tags": [ "Admin" ], "summary": "GET /apps", "operationId": "get_api_app_center_apps", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/app-center/apps/{id}": { "get": { "tags": [ "Admin" ], "summary": "GET /apps/:id", "operationId": "get_api_app_center_apps_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/app-center/categories": { "get": { "tags": [ "Admin" ], "summary": "GET /categories", "operationId": "get_api_app_center_categories", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/app-center/install": { "post": { "tags": [ "Admin" ], "summary": "POST /install", "operationId": "post_api_app_center_install", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/app-center/installed": { "get": { "tags": [ "Admin" ], "summary": "GET /installed", "operationId": "get_api_app_center_installed", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/auth/login": { "post": { "tags": [ "Authority" ], "summary": "POST /login", "operationId": "post_api_auth_login", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "string" }, "password": { "type": "string", "example": "string" }, "app_id": { "type": "string", "example": "string" } }, "required": [ "email", "password" ] }, "example": { "email": "string", "password": "string", "app_id": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/auth/logout": { "post": { "tags": [ "Authority" ], "summary": "POST /logout", "operationId": "post_api_auth_logout", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/auth/me": { "get": { "tags": [ "Authority" ], "summary": "GET /me", "operationId": "get_api_auth_me", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/auto-assign/rules": { "get": { "tags": [ "Advanced" ], "summary": "Rules", "operationId": "get_api_auto_assign_rules", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Advanced" ], "summary": "POST /rules", "operationId": "post_api_auto_assign_rules", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/auto-assign/rules/{id}": { "delete": { "tags": [ "Advanced" ], "summary": "DELETE /rules/:id", "operationId": "delete_api_auto_assign_rules_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Advanced" ], "summary": "PATCH /rules/:id", "operationId": "patch_api_auto_assign_rules_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/auto-assign/sla": { "get": { "tags": [ "Advanced" ], "summary": "SLA Policies", "operationId": "get_api_auto_assign_sla", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Advanced" ], "summary": "POST /sla", "operationId": "post_api_auto_assign_sla", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/auto-assign/sla/{id}": { "delete": { "tags": [ "Advanced" ], "summary": "DELETE /sla/:id", "operationId": "delete_api_auto_assign_sla_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/auto-assign/sla/breaches": { "get": { "tags": [ "Advanced" ], "summary": "Breaches", "operationId": "get_api_auto_assign_sla_breaches", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/billing/balance": { "get": { "tags": [ "Billing" ], "summary": "GET /balance", "operationId": "get_api_billing_balance", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/billing/packages": { "get": { "tags": [ "Billing" ], "summary": "GET /packages", "operationId": "get_api_billing_packages", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/billing/top-up": { "post": { "tags": [ "Billing" ], "summary": "POST /top-up", "operationId": "post_api_billing_top_up", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "packageId": { "type": "string", "example": "string" }, "email": { "type": "string", "example": "string" }, "referenceId": { "type": "string", "example": "string" } }, "required": [ "packageId" ] }, "example": { "packageId": "string", "email": "string", "referenceId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/billing/top-up/create-invoice": { "post": { "tags": [ "Billing" ], "summary": "POST /top-up/create-invoice", "operationId": "post_api_billing_top_up_create_invoice", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "packageName": { "type": "string", "example": "string" }, "email": { "type": "string", "example": "string" } }, "required": [ "packageName" ] }, "example": { "packageName": "string", "email": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/billing/transactions": { "get": { "tags": [ "Billing" ], "summary": "GET /transactions", "operationId": "get_api_billing_transactions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/broadcasts": { "get": { "tags": [ "Broadcast" ], "summary": "GET /", "operationId": "get_api_broadcasts", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Broadcast" ], "summary": "POST /", "operationId": "post_api_broadcasts", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/broadcasts/{id}": { "get": { "tags": [ "Broadcast" ], "summary": "GET /:id", "operationId": "get_api_broadcasts_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/broadcasts/{id}/send": { "post": { "tags": [ "Broadcast" ], "summary": "POST /:id/send", "operationId": "post_api_broadcasts_id_send", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/broadcasts/jobs": { "get": { "tags": [ "Broadcast" ], "summary": "GET /jobs", "operationId": "get_api_broadcasts_jobs", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "statuses", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/broadcasts/jobs/{id}": { "get": { "tags": [ "Broadcast" ], "summary": "GET /jobs/:id", "operationId": "get_api_broadcasts_jobs_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/business_webhooks": { "get": { "tags": [ "Business Webhooks" ], "summary": "GET /", "operationId": "get_api_business_webhooks", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Business Webhooks" ], "summary": "POST /", "operationId": "post_api_business_webhooks", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/business_webhooks/{id}": { "delete": { "tags": [ "Business Webhooks" ], "summary": "DELETE /:id", "operationId": "delete_api_business_webhooks_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Business Webhooks" ], "summary": "PATCH /:id", "operationId": "patch_api_business_webhooks_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/canned-responses": { "get": { "tags": [ "Message" ], "summary": "GET /", "operationId": "get_api_canned_responses", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Message" ], "summary": "POST /", "operationId": "post_api_canned_responses", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/canned-responses/{id}": { "delete": { "tags": [ "Message" ], "summary": "DELETE /:id", "operationId": "delete_api_canned_responses_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/chatbots": { "get": { "tags": [ "Chatbot" ], "summary": "GET /", "operationId": "get_api_chatbots", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Chatbot" ], "summary": "POST /", "operationId": "post_api_chatbots", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/chatbots/{id}": { "delete": { "tags": [ "Chatbot" ], "summary": "DELETE /:id", "operationId": "delete_api_chatbots_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Chatbot" ], "summary": "GET /:id", "operationId": "get_api_chatbots_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Chatbot" ], "summary": "PATCH /:id", "operationId": "patch_api_chatbots_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "Chatbot" ], "summary": "PUT /:id", "operationId": "put_api_chatbots_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/chatbots/{id}/documents": { "get": { "tags": [ "Chatbot" ], "summary": "Documents", "operationId": "get_api_chatbots_id_documents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Chatbot" ], "summary": "POST /:id/documents", "operationId": "post_api_chatbots_id_documents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "string" }, "content": { "type": "string", "example": "string" }, "type": { "type": "string", "example": "string" } }, "required": [ "title", "content" ] }, "example": { "title": "string", "content": "string", "type": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/chatbots/{id}/documents/{docId}": { "delete": { "tags": [ "Chatbot" ], "summary": "DELETE /:id/documents/:docId", "operationId": "delete_api_chatbots_id_documents_docId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "docId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Chatbot" ], "summary": "PATCH /:id/documents/:docId", "operationId": "patch_api_chatbots_id_documents_docId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "docId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/chatbots/{id}/simulate": { "post": { "tags": [ "Chatbot" ], "summary": "POST /:id/simulate", "operationId": "post_api_chatbots_id_simulate", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/chatbots/model-pricing": { "get": { "tags": [ "Chatbot" ], "summary": "GET /model-pricing", "operationId": "get_api_chatbots_model_pricing", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/contacts": { "get": { "tags": [ "Contact" ], "summary": "GET /", "operationId": "get_api_contacts", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Contact" ], "summary": "POST /", "operationId": "post_api_contacts", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/contacts/{id}": { "delete": { "tags": [ "Contact" ], "summary": "DELETE /:id", "operationId": "delete_api_contacts_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Contact" ], "summary": "GET /:id", "operationId": "get_api_contacts_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Contact" ], "summary": "PATCH /:id", "operationId": "patch_api_contacts_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/contacts/{id}/conversations": { "get": { "tags": [ "Contact" ], "summary": "Get conversations for a contact", "operationId": "get_api_contacts_id_conversations", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/contacts/settings": { "get": { "tags": [ "Contact" ], "summary": "GET /settings", "operationId": "get_api_contacts_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/contacts/settings/fields": { "post": { "tags": [ "Contact" ], "summary": "POST /settings/fields", "operationId": "post_api_contacts_settings_fields", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/contacts/settings/fields/{id}": { "delete": { "tags": [ "Contact" ], "summary": "DELETE /settings/fields/:id", "operationId": "delete_api_contacts_settings_fields_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Contact" ], "summary": "PATCH /settings/fields/:id", "operationId": "patch_api_contacts_settings_fields_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/contacts/settings/fields/reorder": { "patch": { "tags": [ "Contact" ], "summary": "PATCH /settings/fields/reorder", "operationId": "patch_api_contacts_settings_fields_reorder", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldIds": { "type": "string", "example": "string" } }, "required": [ "fieldIds" ] }, "example": { "fieldIds": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/contacts/settings/stages": { "post": { "tags": [ "Contact" ], "summary": "POST /settings/stages", "operationId": "post_api_contacts_settings_stages", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "color": { "type": "string", "example": "string" }, "isDefault": { "type": "boolean", "example": true } }, "required": [ "name" ] }, "example": { "name": "string", "color": "string", "isDefault": true } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/contacts/settings/stages/{id}": { "delete": { "tags": [ "Contact" ], "summary": "DELETE /settings/stages/:id", "operationId": "delete_api_contacts_settings_stages_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Contact" ], "summary": "PATCH /settings/stages/:id", "operationId": "patch_api_contacts_settings_stages_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "color": { "type": "string", "example": "string" }, "isDefault": { "type": "boolean", "example": true } } }, "example": { "name": "string", "color": "string", "isDefault": true } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/contacts/settings/stages/reorder": { "patch": { "tags": [ "Contact" ], "summary": "PATCH /settings/stages/reorder", "operationId": "patch_api_contacts_settings_stages_reorder", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "stageIds": { "type": "string", "example": "string" } }, "required": [ "stageIds" ] }, "example": { "stageIds": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations": { "get": { "tags": [ "Conversation" ], "summary": "List conversations with filters", "operationId": "get_api_conversations", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "inboxId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "agentId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "priority", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "labelIds", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "resolvedBy", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "aiAgentId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "pipelineStageId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "channelType", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}": { "get": { "tags": [ "Conversation" ], "summary": "Get conversation by ID", "operationId": "get_api_conversations_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/activity": { "get": { "tags": [ "Conversation" ], "summary": "=== Activity Log ===", "operationId": "get_api_conversations_id_activity", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/agents": { "get": { "tags": [ "Conversation" ], "summary": "GET /:id/agents", "operationId": "get_api_conversations_id_agents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Conversation" ], "summary": "=== Agents ===", "operationId": "post_api_conversations_id_agents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string", "example": "string" }, "agent_id": { "type": "string", "example": "string" } } }, "example": { "agentId": "string", "agent_id": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/agents/{agentId}": { "delete": { "tags": [ "Conversation" ], "summary": "DELETE /:id/agents/:agentId", "operationId": "delete_api_conversations_id_agents_agentId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/assign": { "post": { "tags": [ "Conversation" ], "summary": "Assign agent to conversation", "operationId": "post_api_conversations_id_assign", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string", "example": "string" } }, "required": [ "agentId" ] }, "example": { "agentId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/labels": { "get": { "tags": [ "Conversation" ], "summary": "=== Labels ===", "operationId": "get_api_conversations_id_labels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Conversation" ], "summary": "POST /:id/labels", "operationId": "post_api_conversations_id_labels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "labelId": { "type": "string", "example": "string" } }, "required": [ "labelId" ] }, "example": { "labelId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/labels/{labelId}": { "delete": { "tags": [ "Conversation" ], "summary": "DELETE /:id/labels/:labelId", "operationId": "delete_api_conversations_id_labels_labelId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "labelId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/messages": { "get": { "tags": [ "Conversation" ], "summary": "Get conversation messages", "operationId": "get_api_conversations_id_messages", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Conversation" ], "summary": "POST /:id/messages", "operationId": "post_api_conversations_id_messages", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/notes": { "get": { "tags": [ "Conversation" ], "summary": "=== Notes ===", "operationId": "get_api_conversations_id_notes", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Conversation" ], "summary": "POST /:id/notes", "operationId": "post_api_conversations_id_notes", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "example": "string" } }, "required": [ "content" ] }, "example": { "content": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/notes/{noteId}": { "patch": { "tags": [ "Conversation" ], "summary": "PATCH /:id/notes/:noteId", "operationId": "patch_api_conversations_id_notes_noteId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "example": "string" } }, "required": [ "content" ] }, "example": { "content": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/read": { "post": { "tags": [ "Conversation" ], "summary": "Mark conversation as read", "operationId": "post_api_conversations_id_read", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/resolve": { "post": { "tags": [ "Conversation" ], "summary": "Resolve conversation (shortcut)", "operationId": "post_api_conversations_id_resolve", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/status": { "patch": { "tags": [ "Conversation" ], "summary": "Update conversation status (PATCH)", "operationId": "patch_api_conversations_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "string" } }, "required": [ "status" ] }, "example": { "status": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Conversation" ], "summary": "Update conversation status (POST — frontend uses POST)", "operationId": "post_api_conversations_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "string" } }, "required": [ "status" ] }, "example": { "status": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/{id}/takeover": { "post": { "tags": [ "Conversation" ], "summary": "Take over conversation with current authenticated agent", "operationId": "post_api_conversations_id_takeover", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string", "example": "string" }, "agent_id": { "type": "string", "example": "string" } } }, "example": { "agentId": "string", "agent_id": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/bulk-edit": { "post": { "tags": [ "Conversation" ], "summary": "Queue bulk-edit conversation actions", "operationId": "post_api_conversations_bulk_edit", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "conversationIds": { "type": "string", "example": "string" }, "collaboratorIds": { "type": "string", "example": "string" }, "handledById": { "type": "string", "example": "string" }, "labelId": { "type": "string", "example": "string" }, "pipelineStageId": { "type": "string", "example": "string" }, "resolveStatus": { "type": "string", "example": "open" } }, "required": [ "conversationIds" ] }, "example": { "conversationIds": "string", "collaboratorIds": "string", "handledById": "string", "labelId": "string", "pipelineStageId": "string", "resolveStatus": "open" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/bulk-edit/{jobId}": { "get": { "tags": [ "Conversation" ], "summary": "Get bulk-edit job status", "operationId": "get_api_conversations_bulk_edit_jobId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/conversations/counts": { "get": { "tags": [ "Conversation" ], "summary": "Get conversation status counts", "operationId": "get_api_conversations_counts", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/crm/deals": { "get": { "tags": [ "CRM" ], "summary": "GET /deals", "operationId": "get_api_crm_deals", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "pipelineId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/crm/deals/{conversationId}": { "get": { "tags": [ "CRM" ], "summary": "GET /deals/:conversationId", "operationId": "get_api_crm_deals_conversationId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "CRM" ], "summary": "PATCH /deals/:conversationId", "operationId": "patch_api_crm_deals_conversationId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/crm/pipelines": { "get": { "tags": [ "CRM" ], "summary": "GET /pipelines", "operationId": "get_api_crm_pipelines", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "CRM" ], "summary": "POST /pipelines", "operationId": "post_api_crm_pipelines", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/crm/pipelines/{id}": { "delete": { "tags": [ "CRM" ], "summary": "DELETE /pipelines/:id", "operationId": "delete_api_crm_pipelines_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/customers": { "get": { "tags": [ "Customer" ], "summary": "GET /", "operationId": "get_api_customers", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "pipeline_stage_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "consent_status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "tag_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "channel", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/customers/{id}": { "get": { "tags": [ "Customer" ], "summary": "GET /:id", "operationId": "get_api_customers_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "Customer" ], "summary": "PUT /:id", "operationId": "put_api_customers_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/customers/{id}/tags": { "post": { "tags": [ "Customer" ], "summary": "POST /:id/tags", "operationId": "post_api_customers_id_tags", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tag_id": { "type": "string", "example": "string" }, "tag_name": { "type": "string", "example": "string" } } }, "example": { "tag_id": "string", "tag_name": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/customers/{id}/tags/{tagId}": { "delete": { "tags": [ "Customer" ], "summary": "DELETE /:id/tags/:tagId", "operationId": "delete_api_customers_id_tags_tagId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/customers/stats": { "get": { "tags": [ "Customer" ], "summary": "GET /stats", "operationId": "get_api_customers_stats", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/developer_keys": { "get": { "tags": [ "Developer Keys" ], "summary": "GET /", "operationId": "get_api_developer_keys", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/developer_keys/regenerate": { "post": { "tags": [ "Developer Keys" ], "summary": "POST /regenerate", "operationId": "post_api_developer_keys_regenerate", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/flows": { "get": { "tags": [ "Flow" ], "summary": "GET /", "operationId": "get_api_flows", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Flow" ], "summary": "POST /", "operationId": "post_api_flows", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/flows/{id}": { "delete": { "tags": [ "Flow" ], "summary": "DELETE /:id", "operationId": "delete_api_flows_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Flow" ], "summary": "GET /:id", "operationId": "get_api_flows_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Flow" ], "summary": "PATCH /:id", "operationId": "patch_api_flows_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/flows/{id}/activate": { "post": { "tags": [ "Flow" ], "summary": "POST /:id/activate", "operationId": "post_api_flows_id_activate", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/forms": { "get": { "tags": [ "Advanced" ], "summary": "GET /", "operationId": "get_api_forms", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Advanced" ], "summary": "POST /", "operationId": "post_api_forms", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/forms/{id}": { "get": { "tags": [ "Advanced" ], "summary": "GET /:id", "operationId": "get_api_forms_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/forms/conversation/{id}": { "get": { "tags": [ "Advanced" ], "summary": "GET /conversation/:id", "operationId": "get_api_forms_conversation_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/forms/conversation/{id}/extract": { "post": { "tags": [ "Advanced" ], "summary": "POST /conversation/:id/extract", "operationId": "post_api_forms_conversation_id_extract", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/health": { "get": { "tags": [ "System" ], "summary": "API health check", "operationId": "get_api_health", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } } } }, "/api/inboxes": { "get": { "tags": [ "Inbox" ], "summary": "GET /", "operationId": "get_api_inboxes", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Inbox" ], "summary": "POST /", "operationId": "post_api_inboxes", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/inboxes/{id}": { "delete": { "tags": [ "Inbox" ], "summary": "DELETE /:id", "operationId": "delete_api_inboxes_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Inbox" ], "summary": "GET /:id", "operationId": "get_api_inboxes_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Inbox" ], "summary": "PATCH /:id", "operationId": "patch_api_inboxes_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/instagram-channels": { "get": { "tags": [ "Instagram" ], "summary": "GET /", "operationId": "get_api_instagram_channels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/instagram-channels/{id}": { "delete": { "tags": [ "Instagram" ], "summary": "DELETE /:id", "operationId": "delete_api_instagram_channels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/instagram-channels/{id}/status": { "get": { "tags": [ "Instagram" ], "summary": "GET /:id/status", "operationId": "get_api_instagram_channels_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/instagram-channels/callback": { "get": { "tags": [ "Instagram" ], "summary": "GET /callback", "operationId": "get_api_instagram_channels_callback", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.mode", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.verify_token", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.challenge", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Instagram" ], "summary": "Instagram Webhook Payload (POST) - receives DMs, comments, etc.", "operationId": "post_api_instagram_channels_callback", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/instagram-channels/init-login": { "post": { "tags": [ "Instagram" ], "summary": "POST /init-login", "operationId": "post_api_instagram_channels_init_login", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/knowledge/categories": { "get": { "tags": [ "Knowledge" ], "summary": "Categories", "operationId": "get_api_knowledge_categories", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "chatbotId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Knowledge" ], "summary": "POST /categories", "operationId": "post_api_knowledge_categories", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/knowledge/categories/{id}": { "delete": { "tags": [ "Knowledge" ], "summary": "DELETE /categories/:id", "operationId": "delete_api_knowledge_categories_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/knowledge/faqs": { "get": { "tags": [ "Knowledge" ], "summary": "FAQs", "operationId": "get_api_knowledge_faqs", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "chatbotId", "in": "query", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "categoryId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Knowledge" ], "summary": "POST /faqs", "operationId": "post_api_knowledge_faqs", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/knowledge/faqs/{id}": { "delete": { "tags": [ "Knowledge" ], "summary": "DELETE /faqs/:id", "operationId": "delete_api_knowledge_faqs_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Knowledge" ], "summary": "PATCH /faqs/:id", "operationId": "patch_api_knowledge_faqs_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/knowledge/sources": { "get": { "tags": [ "Knowledge" ], "summary": "Sources (Mapped from FAQs for now or create service for it)", "operationId": "get_api_knowledge_sources", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "chatbotId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "categoryId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/knowledge/stats": { "get": { "tags": [ "Knowledge" ], "summary": "Stats", "operationId": "get_api_knowledge_stats", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "chatbotId", "in": "query", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/labels": { "get": { "tags": [ "Label" ], "summary": "GET /", "operationId": "get_api_labels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Label" ], "summary": "POST /", "operationId": "post_api_labels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/labels/{id}": { "delete": { "tags": [ "Label" ], "summary": "DELETE /:id", "operationId": "delete_api_labels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Label" ], "summary": "PATCH /:id", "operationId": "patch_api_labels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/labels/conversation/{id}": { "get": { "tags": [ "Label" ], "summary": "Conversation Labels", "operationId": "get_api_labels_conversation_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Label" ], "summary": "POST /conversation/:id", "operationId": "post_api_labels_conversation_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "labelId": { "type": "string", "example": "string" } }, "required": [ "labelId" ] }, "example": { "labelId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/labels/conversation/{id}/{labelId}": { "delete": { "tags": [ "Label" ], "summary": "DELETE /conversation/:id/:labelId", "operationId": "delete_api_labels_conversation_id_labelId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "labelId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/media/gallery": { "get": { "tags": [ "Media" ], "summary": "GET /gallery", "operationId": "get_api_media_gallery", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "take", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/media/upload": { "post": { "tags": [ "Media" ], "summary": "POST /upload", "operationId": "post_api_media_upload", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "example": "" }, "platform": { "type": "string", "example": "string" } }, "required": [ "file" ] }, "example": { "file": "", "platform": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/messages": { "post": { "tags": [ "Message" ], "summary": "Send a message", "operationId": "post_api_messages", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "conversationId": { "type": "string", "example": "string" }, "senderId": { "type": "string", "example": "string" }, "content": { "type": "string", "example": "string" }, "contentType": { "type": "string", "example": "string" }, "mediaIds": { "type": "string", "example": "string" } }, "required": [ "conversationId", "content" ] }, "example": { "conversationId": "string", "senderId": "string", "content": "string", "contentType": "string", "mediaIds": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/messages/{id}": { "delete": { "tags": [ "Message" ], "summary": "Delete message (soft delete)", "operationId": "delete_api_messages_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Message" ], "summary": "Get message by ID", "operationId": "get_api_messages_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/messages/{id}/status": { "patch": { "tags": [ "Message" ], "summary": "Update message status", "operationId": "patch_api_messages_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "string" }, "externalId": { "type": "string", "example": "string" } }, "required": [ "status" ] }, "example": { "status": "string", "externalId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/meta-ads/accounts": { "get": { "tags": [ "Admin" ], "summary": "GET /accounts", "operationId": "get_api_meta_ads_accounts", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/meta-ads/campaigns": { "get": { "tags": [ "Admin" ], "summary": "GET /campaigns", "operationId": "get_api_meta_ads_campaigns", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/meta-ads/insights/summary": { "get": { "tags": [ "Admin" ], "summary": "GET /insights/summary", "operationId": "get_api_meta_ads_insights_summary", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/metrics/ai": { "get": { "tags": [ "Advanced" ], "summary": "GET /ai", "operationId": "get_api_metrics_ai", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/metrics/dashboard": { "get": { "tags": [ "Advanced" ], "summary": "GET /dashboard", "operationId": "get_api_metrics_dashboard", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/metrics/summary": { "get": { "tags": [ "Advanced" ], "summary": "GET /summary", "operationId": "get_api_metrics_summary", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/orchestration/agents": { "get": { "tags": [ "AI" ], "summary": "GET /agents", "operationId": "get_api_orchestration_agents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/orchestration/decide": { "post": { "tags": [ "AI" ], "summary": "POST /decide", "operationId": "post_api_orchestration_decide", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/orchestration/handoff": { "post": { "tags": [ "AI" ], "summary": "POST /handoff", "operationId": "post_api_orchestration_handoff", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/orchestration/handoffs/{conversationId}": { "get": { "tags": [ "AI" ], "summary": "GET /handoffs/:conversationId", "operationId": "get_api_orchestration_handoffs_conversationId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/orders": { "get": { "tags": [ "Orders" ], "summary": "GET /", "operationId": "get_api_orders", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "payment_type", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "order_status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "inbox_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "sort_field", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "sort_direction", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "include_conv", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/orders/report": { "get": { "tags": [ "Orders" ], "summary": "GET /report", "operationId": "get_api_orders_report", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/orders/subscriptions": { "get": { "tags": [ "Orders" ], "summary": "GET /subscriptions", "operationId": "get_api_orders_subscriptions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "sort_field", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "sort_direction", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/organization/create": { "post": { "tags": [ "Organization" ], "summary": "POST /create", "operationId": "post_api_organization_create", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "slug": { "type": "string", "example": "string" }, "logo": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "string" } }, "required": [ "name", "slug" ] }, "example": { "name": "string", "slug": "string", "logo": "string", "description": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/organization/delete": { "post": { "tags": [ "Organization" ], "summary": "POST /delete", "operationId": "post_api_organization_delete", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": "string", "example": "string" } }, "required": [ "organizationId" ] }, "example": { "organizationId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/organization/get-active": { "get": { "tags": [ "Organization" ], "summary": "GET /get-active", "operationId": "get_api_organization_get_active", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/organization/get-members": { "get": { "tags": [ "Organization" ], "summary": "GET /get-members", "operationId": "get_api_organization_get_members", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/organization/invite-member": { "post": { "tags": [ "Organization" ], "summary": "POST /invite-member", "operationId": "post_api_organization_invite_member", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": "string", "example": "string" }, "email": { "type": "string", "example": "string" }, "role": { "type": "string", "example": "admin" } }, "required": [ "organizationId", "email" ] }, "example": { "organizationId": "string", "email": "string", "role": "admin" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/organization/list": { "get": { "tags": [ "Organization" ], "summary": "GET /list", "operationId": "get_api_organization_list", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/organization/remove-member": { "post": { "tags": [ "Organization" ], "summary": "POST /remove-member", "operationId": "post_api_organization_remove_member", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": "string", "example": "string" }, "memberId": { "type": "string", "example": "string" } }, "required": [ "organizationId", "memberId" ] }, "example": { "organizationId": "string", "memberId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/organization/set-active": { "post": { "tags": [ "Organization" ], "summary": "POST /set-active", "operationId": "post_api_organization_set_active", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": "string", "example": "string" } }, "required": [ "organizationId" ] }, "example": { "organizationId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/organization/update": { "post": { "tags": [ "Organization" ], "summary": "POST /update", "operationId": "post_api_organization_update", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": "string", "example": "string" }, "data": { "type": "string", "example": "string" } }, "required": [ "organizationId" ] }, "example": { "organizationId": "string", "data": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/organization/update-member-role": { "post": { "tags": [ "Organization" ], "summary": "POST /update-member-role", "operationId": "post_api_organization_update_member_role", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": "string", "example": "string" }, "memberId": { "type": "string", "example": "string" }, "role": { "type": "string", "example": "admin" } }, "required": [ "organizationId", "memberId", "role" ] }, "example": { "organizationId": "string", "memberId": "string", "role": "admin" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/companies": { "get": { "tags": [ "Super Admin" ], "summary": "GET /companies", "operationId": "get_api_super_admin_companies", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/companies/{id}/status": { "patch": { "tags": [ "Super Admin" ], "summary": "PATCH /companies/:id/status", "operationId": "patch_api_super_admin_companies_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/companies/{id}/top-up": { "post": { "tags": [ "Super Admin" ], "summary": "POST /companies/:id/top-up", "operationId": "post_api_super_admin_companies_id_top_up", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/credits/adjust": { "post": { "tags": [ "Super Admin" ], "summary": "POST /credits/adjust", "operationId": "post_api_super_admin_credits_adjust", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/credits/balance/{orgId}": { "get": { "tags": [ "Super Admin" ], "summary": "GET /credits/balance/:orgId", "operationId": "get_api_super_admin_credits_balance_orgId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/credits/model-pricing": { "get": { "tags": [ "Super Admin" ], "summary": "GET /credits/model-pricing", "operationId": "get_api_super_admin_credits_model_pricing", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Super Admin" ], "summary": "POST /credits/model-pricing", "operationId": "post_api_super_admin_credits_model_pricing", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/credits/packages": { "get": { "tags": [ "Super Admin" ], "summary": "GET /credits/packages", "operationId": "get_api_super_admin_credits_packages", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/reports/usage": { "get": { "tags": [ "Super Admin" ], "summary": "GET /reports/usage", "operationId": "get_api_super_admin_reports_usage", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/stats": { "get": { "tags": [ "Super Admin" ], "summary": "GET /stats", "operationId": "get_api_super_admin_stats", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/users": { "get": { "tags": [ "Super Admin" ], "summary": "GET /users", "operationId": "get_api_super_admin_users", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/users/{id}/role": { "patch": { "tags": [ "Super Admin" ], "summary": "PATCH /users/:id/role", "operationId": "patch_api_super_admin_users_id_role", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/users/{id}/suspend": { "post": { "tags": [ "Super Admin" ], "summary": "POST /users/:id/suspend", "operationId": "post_api_super_admin_users_id_suspend", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/super-admin/webhooks": { "get": { "tags": [ "Super Admin" ], "summary": "GET /webhooks", "operationId": "get_api_super_admin_webhooks", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/teams": { "get": { "tags": [ "Team" ], "summary": "GET /", "operationId": "get_api_teams", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Team" ], "summary": "POST /", "operationId": "post_api_teams", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/teams/{id}": { "delete": { "tags": [ "Team" ], "summary": "DELETE /:id", "operationId": "delete_api_teams_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Team" ], "summary": "GET /:id", "operationId": "get_api_teams_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Team" ], "summary": "PATCH /:id", "operationId": "patch_api_teams_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/teams/{id}/members": { "post": { "tags": [ "Team" ], "summary": "POST /:id/members", "operationId": "post_api_teams_id_members", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "example": "string" } }, "required": [ "userId" ] }, "example": { "userId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/teams/{id}/members/{userId}": { "delete": { "tags": [ "Team" ], "summary": "DELETE /:id/members/:userId", "operationId": "delete_api_teams_id_members_userId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/template-variables": { "get": { "tags": [ "Template Variables" ], "summary": "GET /", "operationId": "get_api_template_variables", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Template Variables" ], "summary": "POST /", "operationId": "post_api_template_variables", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/template-variables/{id}": { "delete": { "tags": [ "Template Variables" ], "summary": "DELETE /:id", "operationId": "delete_api_template_variables_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/templates": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /templates", "operationId": "get_api_templates", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "channelId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/templates/sync": { "post": { "tags": [ "WhatsApp" ], "summary": "POST /templates/sync", "operationId": "post_api_templates_sync", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channelId": { "type": "string", "example": "string" } } }, "example": { "channelId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/tickets/conversations/{conversationId}": { "get": { "tags": [ "Tickets" ], "summary": "GET /conversations/:conversationId", "operationId": "get_api_tickets_conversations_conversationId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "board_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Tickets" ], "summary": "PATCH /conversations/:conversationId", "operationId": "patch_api_tickets_conversations_conversationId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/tickets/conversations/{conversationId}/move": { "post": { "tags": [ "Tickets" ], "summary": "POST /conversations/:conversationId/move", "operationId": "post_api_tickets_conversations_conversationId_move", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/tickets/conversations/{conversationId}/status": { "patch": { "tags": [ "Tickets" ], "summary": "PATCH /conversations/:conversationId/status", "operationId": "patch_api_tickets_conversations_conversationId_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/tickets/kanban": { "post": { "tags": [ "Tickets" ], "summary": "POST /kanban", "operationId": "post_api_tickets_kanban", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/tickets/settings": { "get": { "tags": [ "Tickets" ], "summary": "GET /settings", "operationId": "get_api_tickets_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/tickets/settings/default-board": { "put": { "tags": [ "Tickets" ], "summary": "PUT /settings/default-board", "operationId": "put_api_tickets_settings_default_board", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/tiktok-channels": { "get": { "tags": [ "TikTok" ], "summary": "GET /", "operationId": "get_api_tiktok_channels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/tiktok-channels/{id}": { "delete": { "tags": [ "TikTok" ], "summary": "DELETE /:id", "operationId": "delete_api_tiktok_channels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/tiktok-channels/{id}/status": { "get": { "tags": [ "TikTok" ], "summary": "GET /:id/status", "operationId": "get_api_tiktok_channels_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/tiktok-channels/callback": { "get": { "tags": [ "TikTok" ], "summary": "GET /callback", "operationId": "get_api_tiktok_channels_callback", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/tiktok-channels/init-login": { "post": { "tags": [ "TikTok" ], "summary": "POST /init-login", "operationId": "post_api_tiktok_channels_init_login", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/tiktok-channels/redirect_uri": { "get": { "tags": [ "TikTok" ], "summary": "GET redirect_uri", "operationId": "get_api_tiktok_channels_redirect_uri", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/user": { "get": { "tags": [ "User" ], "summary": "Get all users for an account", "operationId": "get_api_user", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/user/{id}": { "get": { "tags": [ "User" ], "summary": "Get user by ID", "operationId": "get_api_user_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "User" ], "summary": "Update user profile", "operationId": "patch_api_user_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/user/{id}/presence": { "get": { "tags": [ "User" ], "summary": "Get user presence", "operationId": "get_api_user_id_presence", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "User" ], "summary": "Update user presence", "operationId": "post_api_user_id_presence", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "string" } }, "required": [ "status" ] }, "example": { "status": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/user/timezone": { "get": { "tags": [ "User" ], "summary": "Get user timezone", "operationId": "get_api_user_timezone", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "User" ], "summary": "Update user timezone", "operationId": "put_api_user_timezone", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "example": "string" } }, "required": [ "timezone" ] }, "example": { "timezone": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/user/timezone/detect": { "post": { "tags": [ "User" ], "summary": "Detect user timezone", "operationId": "post_api_user_timezone_detect", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detected_timezone": { "type": "string", "example": "string" } } }, "example": { "detected_timezone": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/user/timezone/reset": { "post": { "tags": [ "User" ], "summary": "Reset user timezone", "operationId": "post_api_user_timezone_reset", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/apps": { "get": { "tags": [ "Admin" ], "summary": "GET /apps", "operationId": "get_api_v1_admin_apps", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/apps/{id}": { "get": { "tags": [ "Admin" ], "summary": "GET /apps/:id", "operationId": "get_api_v1_admin_apps_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/apps/{id}/status": { "patch": { "tags": [ "Admin" ], "summary": "PATCH /apps/:id/status", "operationId": "patch_api_v1_admin_apps_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "isActive": { "type": "boolean", "example": true } }, "required": [ "isActive" ] }, "example": { "isActive": true } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/apps/{id}/top-up": { "post": { "tags": [ "Admin" ], "summary": "POST /apps/:id/top-up", "operationId": "post_api_v1_admin_apps_id_top_up", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "example": 0 }, "reason": { "type": "string", "example": "string" } }, "required": [ "amount" ] }, "example": { "amount": 0, "reason": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/billing/organizations": { "get": { "tags": [ "Admin" ], "summary": "GET /billing/organizations", "operationId": "get_api_v1_admin_billing_organizations", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/billing/organizations/{id}/balance": { "get": { "tags": [ "Admin" ], "summary": "GET /billing/organizations/:id/balance", "operationId": "get_api_v1_admin_billing_organizations_id_balance", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/billing/organizations/{id}/credits": { "post": { "tags": [ "Admin" ], "summary": "POST /billing/organizations/:id/credits", "operationId": "post_api_v1_admin_billing_organizations_id_credits", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "example": 0 }, "reason": { "type": "string", "example": "string" }, "adminId": { "type": "string", "example": "string" } }, "required": [ "amount" ] }, "example": { "amount": 0, "reason": "string", "adminId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/billing/organizations/{id}/transactions": { "get": { "tags": [ "Admin" ], "summary": "GET /billing/organizations/:id/transactions", "operationId": "get_api_v1_admin_billing_organizations_id_transactions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/billing/payment-requests": { "get": { "tags": [ "Admin" ], "summary": "GET /billing/payment-requests", "operationId": "get_api_v1_admin_billing_payment_requests", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/billing/payment-requests/{id}": { "get": { "tags": [ "Admin" ], "summary": "GET /billing/payment-requests/:id", "operationId": "get_api_v1_admin_billing_payment_requests_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/billing/pricing": { "get": { "tags": [ "Admin" ], "summary": "GET /billing/pricing", "operationId": "get_api_v1_admin_billing_pricing", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Admin" ], "summary": "POST /billing/pricing", "operationId": "post_api_v1_admin_billing_pricing", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "modelName": { "type": "string", "example": "string" }, "costPerRequest": { "type": "number", "example": 0 }, "description": { "type": "string", "example": "string" } }, "required": [ "modelName", "costPerRequest" ] }, "example": { "modelName": "string", "costPerRequest": 0, "description": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/billing/pricing/{id}": { "delete": { "tags": [ "Admin" ], "summary": "DELETE /billing/pricing/:id", "operationId": "delete_api_v1_admin_billing_pricing_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "Admin" ], "summary": "PUT /billing/pricing/:id", "operationId": "put_api_v1_admin_billing_pricing_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "costPerRequest": { "type": "number", "example": 0 }, "description": { "type": "string", "example": "string" }, "isActive": { "type": "boolean", "example": true } }, "required": [ "costPerRequest" ] }, "example": { "costPerRequest": 0, "description": "string", "isActive": true } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/members": { "get": { "tags": [ "Admin" ], "summary": "GET /members", "operationId": "get_api_v1_admin_members", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/members/{id}/role": { "patch": { "tags": [ "Admin" ], "summary": "PATCH /members/:id/role", "operationId": "patch_api_v1_admin_members_id_role", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "example": "string" } }, "required": [ "role" ] }, "example": { "role": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/organizations": { "get": { "tags": [ "Admin" ], "summary": "GET /organizations", "operationId": "get_api_v1_admin_organizations", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/queues/{name}/retry": { "post": { "tags": [ "Admin" ], "summary": "POST /queues/:name/retry", "operationId": "post_api_v1_admin_queues_name_retry", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/queues/stats": { "get": { "tags": [ "Admin" ], "summary": "GET /queues/stats", "operationId": "get_api_v1_admin_queues_stats", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/stats": { "get": { "tags": [ "Admin" ], "summary": "GET /stats", "operationId": "get_api_v1_admin_stats", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/subscriptions": { "get": { "tags": [ "Admin" ], "summary": "GET /subscriptions", "operationId": "get_api_v1_admin_subscriptions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/subscriptions/{id}": { "get": { "tags": [ "Admin" ], "summary": "GET /subscriptions/:id", "operationId": "get_api_v1_admin_subscriptions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Admin" ], "summary": "PATCH /subscriptions/:id", "operationId": "patch_api_v1_admin_subscriptions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "string" }, "subscriptionType": { "type": "string", "example": "string" }, "itemName": { "type": "string", "example": "string" }, "billingAmount": { "type": "number", "example": 0 }, "cycles": { "type": "number", "example": 0 }, "startDate": { "type": "string", "example": "string" }, "nextBilling": { "type": "string", "example": "string" }, "endDate": { "type": "string", "example": "string" } } }, "example": { "status": "string", "subscriptionType": "string", "itemName": "string", "billingAmount": 0, "cycles": 0, "startDate": "string", "nextBilling": "string", "endDate": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/usage/summary": { "get": { "tags": [ "Admin" ], "summary": "GET /usage/summary", "operationId": "get_api_v1_admin_usage_summary", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/users/{id}/suspend": { "post": { "tags": [ "Admin" ], "summary": "POST /users/:id/suspend", "operationId": "post_api_v1_admin_users_id_suspend", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/users/{id}/unsuspend": { "post": { "tags": [ "Admin" ], "summary": "POST /users/:id/unsuspend", "operationId": "post_api_v1_admin_users_id_unsuspend", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/webhook-events": { "get": { "tags": [ "Admin" ], "summary": "GET /webhook-events", "operationId": "get_api_v1_admin_webhook_events", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/webhook-events/{id}": { "get": { "tags": [ "Admin" ], "summary": "GET /webhook-events/:id", "operationId": "get_api_v1_admin_webhook_events_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/xendit/settings": { "get": { "tags": [ "Admin" ], "summary": "GET /xendit/settings", "operationId": "get_api_v1_admin_xendit_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "Admin" ], "summary": "PUT /xendit/settings", "operationId": "put_api_v1_admin_xendit_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "reconciliationEnabled": { "type": "boolean", "example": true }, "secretKey": { "type": "string", "example": "string" }, "callbackToken": { "type": "string", "example": "string" }, "clearSecretKey": { "type": "boolean", "example": true }, "clearCallbackToken": { "type": "boolean", "example": true } } }, "example": { "enabled": true, "reconciliationEnabled": true, "secretKey": "string", "callbackToken": "string", "clearSecretKey": true, "clearCallbackToken": true } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/admin/xendit/test": { "post": { "tags": [ "Admin" ], "summary": "POST /xendit/test", "operationId": "post_api_v1_admin_xendit_test", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/agent-settings": { "get": { "tags": [ "Admin" ], "summary": "GET /", "operationId": "get_api_v1_agent_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "Admin" ], "summary": "PUT /", "operationId": "put_api_v1_agent_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/agents": { "get": { "tags": [ "User" ], "summary": "GET /", "operationId": "get_api_v1_agents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "User" ], "summary": "POST /", "operationId": "post_api_v1_agents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/agents-management": { "get": { "tags": [ "User" ], "summary": "GET /", "operationId": "get_api_v1_agents_management", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "User" ], "summary": "POST /", "operationId": "post_api_v1_agents_management", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/agents-management/{id}": { "delete": { "tags": [ "User" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_agents_management_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "User" ], "summary": "PATCH /:id", "operationId": "patch_api_v1_agents_management_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "User" ], "summary": "PUT /:id", "operationId": "put_api_v1_agents_management_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/agents-management/divisions": { "get": { "tags": [ "User" ], "summary": "Divisions", "operationId": "get_api_v1_agents_management_divisions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "User" ], "summary": "POST /divisions", "operationId": "post_api_v1_agents_management_divisions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "string" }, "color": { "type": "string", "example": "string" } }, "required": [ "name" ] }, "example": { "name": "string", "description": "string", "color": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/agents-management/divisions/{id}": { "delete": { "tags": [ "User" ], "summary": "DELETE /divisions/:id", "operationId": "delete_api_v1_agents_management_divisions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "User" ], "summary": "PUT /divisions/:id", "operationId": "put_api_v1_agents_management_divisions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "string" }, "color": { "type": "string", "example": "string" }, "parent_division_id": { "type": "string", "example": "string" } } }, "example": { "name": "string", "description": "string", "color": "string", "parent_division_id": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/agents-management/login-link": { "get": { "tags": [ "User" ], "summary": "GET /login-link", "operationId": "get_api_v1_agents_management_login_link", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/agents/{id}": { "delete": { "tags": [ "User" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_agents_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "User" ], "summary": "PATCH /:id", "operationId": "patch_api_v1_agents_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "User" ], "summary": "PUT /:id", "operationId": "put_api_v1_agents_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/agents/divisions": { "get": { "tags": [ "User" ], "summary": "Divisions", "operationId": "get_api_v1_agents_divisions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "User" ], "summary": "POST /divisions", "operationId": "post_api_v1_agents_divisions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "string" }, "color": { "type": "string", "example": "string" } }, "required": [ "name" ] }, "example": { "name": "string", "description": "string", "color": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/agents/divisions/{id}": { "delete": { "tags": [ "User" ], "summary": "DELETE /divisions/:id", "operationId": "delete_api_v1_agents_divisions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "User" ], "summary": "PUT /divisions/:id", "operationId": "put_api_v1_agents_divisions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "description": { "type": "string", "example": "string" }, "color": { "type": "string", "example": "string" }, "parent_division_id": { "type": "string", "example": "string" } } }, "example": { "name": "string", "description": "string", "color": "string", "parent_division_id": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/agents/login-link": { "get": { "tags": [ "User" ], "summary": "GET /login-link", "operationId": "get_api_v1_agents_login_link", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/ai_tools": { "get": { "tags": [ "API Tools" ], "summary": "GET /", "operationId": "get_api_v1_ai_tools", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "API Tools" ], "summary": "POST /", "operationId": "post_api_v1_ai_tools", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "API Tools" ], "summary": "PUT /", "operationId": "put_api_v1_ai_tools", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/ai_tools/{id}": { "delete": { "tags": [ "API Tools" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_ai_tools_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "API Tools" ], "summary": "PATCH /:id", "operationId": "patch_api_v1_ai_tools_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/ai_tools/execute": { "post": { "tags": [ "API Tools" ], "summary": "POST /execute", "operationId": "post_api_v1_ai_tools_execute", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/ai/evaluate": { "post": { "tags": [ "AI" ], "summary": "POST /evaluate", "operationId": "post_api_v1_ai_evaluate", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "appId": { "type": "string", "example": "string" }, "conversationId": { "type": "string", "example": "string" }, "score": { "type": "number", "example": 0 }, "feedback": { "type": "string", "example": "string" } }, "required": [ "conversationId", "score" ] }, "example": { "appId": "string", "conversationId": "string", "score": 0, "feedback": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/ai/generate": { "post": { "tags": [ "AI" ], "summary": "POST /generate", "operationId": "post_api_v1_ai_generate", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "string" }, "conversationId": { "type": "string", "example": "string" } }, "required": [ "message" ] }, "example": { "message": "string", "conversationId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/ai/providers": { "get": { "tags": [ "AI" ], "summary": "GET /providers", "operationId": "get_api_v1_ai_providers", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/ai/providers/{provider}": { "put": { "tags": [ "AI" ], "summary": "PUT /providers/:provider", "operationId": "put_api_v1_ai_providers_provider", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "example": "growthcircle" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/ai/providers/active": { "patch": { "tags": [ "AI" ], "summary": "PATCH /providers/active", "operationId": "patch_api_v1_ai_providers_active", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/ai/settings": { "get": { "tags": [ "AI" ], "summary": "GET /settings", "operationId": "get_api_v1_ai_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "AI" ], "summary": "PATCH /settings", "operationId": "patch_api_v1_ai_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/ai/suggest/{conversationId}": { "get": { "tags": [ "AI" ], "summary": "GET /suggest/:conversationId", "operationId": "get_api_v1_ai_suggest_conversationId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/app-center/apps": { "get": { "tags": [ "Admin" ], "summary": "GET /apps", "operationId": "get_api_v1_app_center_apps", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/app-center/apps/{id}": { "get": { "tags": [ "Admin" ], "summary": "GET /apps/:id", "operationId": "get_api_v1_app_center_apps_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/app-center/categories": { "get": { "tags": [ "Admin" ], "summary": "GET /categories", "operationId": "get_api_v1_app_center_categories", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/app-center/install": { "post": { "tags": [ "Admin" ], "summary": "POST /install", "operationId": "post_api_v1_app_center_install", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/app-center/installed": { "get": { "tags": [ "Admin" ], "summary": "GET /installed", "operationId": "get_api_v1_app_center_installed", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/auto-assign/rules": { "get": { "tags": [ "Advanced" ], "summary": "Rules", "operationId": "get_api_v1_auto_assign_rules", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Advanced" ], "summary": "POST /rules", "operationId": "post_api_v1_auto_assign_rules", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/auto-assign/rules/{id}": { "delete": { "tags": [ "Advanced" ], "summary": "DELETE /rules/:id", "operationId": "delete_api_v1_auto_assign_rules_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Advanced" ], "summary": "PATCH /rules/:id", "operationId": "patch_api_v1_auto_assign_rules_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/auto-assign/sla": { "get": { "tags": [ "Advanced" ], "summary": "SLA Policies", "operationId": "get_api_v1_auto_assign_sla", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Advanced" ], "summary": "POST /sla", "operationId": "post_api_v1_auto_assign_sla", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/auto-assign/sla/{id}": { "delete": { "tags": [ "Advanced" ], "summary": "DELETE /sla/:id", "operationId": "delete_api_v1_auto_assign_sla_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/auto-assign/sla/breaches": { "get": { "tags": [ "Advanced" ], "summary": "Breaches", "operationId": "get_api_v1_auto_assign_sla_breaches", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/billing/balance": { "get": { "tags": [ "Billing" ], "summary": "GET /balance", "operationId": "get_api_v1_billing_balance", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/billing/packages": { "get": { "tags": [ "Billing" ], "summary": "GET /packages", "operationId": "get_api_v1_billing_packages", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/billing/top-up": { "post": { "tags": [ "Billing" ], "summary": "POST /top-up", "operationId": "post_api_v1_billing_top_up", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "packageId": { "type": "string", "example": "string" }, "email": { "type": "string", "example": "string" }, "referenceId": { "type": "string", "example": "string" } }, "required": [ "packageId" ] }, "example": { "packageId": "string", "email": "string", "referenceId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/billing/top-up/create-invoice": { "post": { "tags": [ "Billing" ], "summary": "POST /top-up/create-invoice", "operationId": "post_api_v1_billing_top_up_create_invoice", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "packageName": { "type": "string", "example": "string" }, "email": { "type": "string", "example": "string" } }, "required": [ "packageName" ] }, "example": { "packageName": "string", "email": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/billing/transactions": { "get": { "tags": [ "Billing" ], "summary": "GET /transactions", "operationId": "get_api_v1_billing_transactions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/broadcasts": { "get": { "tags": [ "Broadcast" ], "summary": "GET /", "operationId": "get_api_v1_broadcasts", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Broadcast" ], "summary": "POST /", "operationId": "post_api_v1_broadcasts", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/broadcasts/{id}": { "get": { "tags": [ "Broadcast" ], "summary": "GET /:id", "operationId": "get_api_v1_broadcasts_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/broadcasts/{id}/send": { "post": { "tags": [ "Broadcast" ], "summary": "POST /:id/send", "operationId": "post_api_v1_broadcasts_id_send", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/broadcasts/jobs": { "get": { "tags": [ "Broadcast" ], "summary": "GET /jobs", "operationId": "get_api_v1_broadcasts_jobs", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "statuses", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/broadcasts/jobs/{id}": { "get": { "tags": [ "Broadcast" ], "summary": "GET /jobs/:id", "operationId": "get_api_v1_broadcasts_jobs_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/business_webhooks": { "get": { "tags": [ "Business Webhooks" ], "summary": "GET /", "operationId": "get_api_v1_business_webhooks", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Business Webhooks" ], "summary": "POST /", "operationId": "post_api_v1_business_webhooks", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/business_webhooks/{id}": { "delete": { "tags": [ "Business Webhooks" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_business_webhooks_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Business Webhooks" ], "summary": "PATCH /:id", "operationId": "patch_api_v1_business_webhooks_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "business_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/canned-responses": { "get": { "tags": [ "Message" ], "summary": "GET /", "operationId": "get_api_v1_canned_responses", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Message" ], "summary": "POST /", "operationId": "post_api_v1_canned_responses", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/canned-responses/{id}": { "delete": { "tags": [ "Message" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_canned_responses_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/chatbots": { "get": { "tags": [ "Chatbot" ], "summary": "GET /", "operationId": "get_api_v1_chatbots", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Chatbot" ], "summary": "POST /", "operationId": "post_api_v1_chatbots", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/chatbots/{id}": { "delete": { "tags": [ "Chatbot" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_chatbots_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Chatbot" ], "summary": "GET /:id", "operationId": "get_api_v1_chatbots_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Chatbot" ], "summary": "PATCH /:id", "operationId": "patch_api_v1_chatbots_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "Chatbot" ], "summary": "PUT /:id", "operationId": "put_api_v1_chatbots_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/chatbots/{id}/documents": { "get": { "tags": [ "Chatbot" ], "summary": "Documents", "operationId": "get_api_v1_chatbots_id_documents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Chatbot" ], "summary": "POST /:id/documents", "operationId": "post_api_v1_chatbots_id_documents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "string" }, "content": { "type": "string", "example": "string" }, "type": { "type": "string", "example": "string" } }, "required": [ "title", "content" ] }, "example": { "title": "string", "content": "string", "type": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/chatbots/{id}/documents/{docId}": { "delete": { "tags": [ "Chatbot" ], "summary": "DELETE /:id/documents/:docId", "operationId": "delete_api_v1_chatbots_id_documents_docId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "docId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Chatbot" ], "summary": "PATCH /:id/documents/:docId", "operationId": "patch_api_v1_chatbots_id_documents_docId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "docId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/chatbots/{id}/simulate": { "post": { "tags": [ "Chatbot" ], "summary": "POST /:id/simulate", "operationId": "post_api_v1_chatbots_id_simulate", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/chatbots/model-pricing": { "get": { "tags": [ "Chatbot" ], "summary": "GET /model-pricing", "operationId": "get_api_v1_chatbots_model_pricing", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/contacts": { "get": { "tags": [ "Contact" ], "summary": "GET /", "operationId": "get_api_v1_contacts", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Contact" ], "summary": "POST /", "operationId": "post_api_v1_contacts", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/contacts/{id}": { "delete": { "tags": [ "Contact" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_contacts_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Contact" ], "summary": "GET /:id", "operationId": "get_api_v1_contacts_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Contact" ], "summary": "PATCH /:id", "operationId": "patch_api_v1_contacts_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/contacts/{id}/conversations": { "get": { "tags": [ "Contact" ], "summary": "Get conversations for a contact", "operationId": "get_api_v1_contacts_id_conversations", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/contacts/settings": { "get": { "tags": [ "Contact" ], "summary": "GET /settings", "operationId": "get_api_v1_contacts_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/contacts/settings/fields": { "post": { "tags": [ "Contact" ], "summary": "POST /settings/fields", "operationId": "post_api_v1_contacts_settings_fields", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/contacts/settings/fields/{id}": { "delete": { "tags": [ "Contact" ], "summary": "DELETE /settings/fields/:id", "operationId": "delete_api_v1_contacts_settings_fields_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Contact" ], "summary": "PATCH /settings/fields/:id", "operationId": "patch_api_v1_contacts_settings_fields_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/contacts/settings/fields/reorder": { "patch": { "tags": [ "Contact" ], "summary": "PATCH /settings/fields/reorder", "operationId": "patch_api_v1_contacts_settings_fields_reorder", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldIds": { "type": "string", "example": "string" } }, "required": [ "fieldIds" ] }, "example": { "fieldIds": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/contacts/settings/stages": { "post": { "tags": [ "Contact" ], "summary": "POST /settings/stages", "operationId": "post_api_v1_contacts_settings_stages", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "color": { "type": "string", "example": "string" }, "isDefault": { "type": "boolean", "example": true } }, "required": [ "name" ] }, "example": { "name": "string", "color": "string", "isDefault": true } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/contacts/settings/stages/{id}": { "delete": { "tags": [ "Contact" ], "summary": "DELETE /settings/stages/:id", "operationId": "delete_api_v1_contacts_settings_stages_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Contact" ], "summary": "PATCH /settings/stages/:id", "operationId": "patch_api_v1_contacts_settings_stages_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "string" }, "color": { "type": "string", "example": "string" }, "isDefault": { "type": "boolean", "example": true } } }, "example": { "name": "string", "color": "string", "isDefault": true } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/contacts/settings/stages/reorder": { "patch": { "tags": [ "Contact" ], "summary": "PATCH /settings/stages/reorder", "operationId": "patch_api_v1_contacts_settings_stages_reorder", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "stageIds": { "type": "string", "example": "string" } }, "required": [ "stageIds" ] }, "example": { "stageIds": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations": { "get": { "tags": [ "Conversation" ], "summary": "List conversations with filters", "operationId": "get_api_v1_conversations", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "inboxId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "agentId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "priority", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "labelIds", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "resolvedBy", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "aiAgentId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "pipelineStageId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "channelType", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}": { "get": { "tags": [ "Conversation" ], "summary": "Get conversation by ID", "operationId": "get_api_v1_conversations_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/activity": { "get": { "tags": [ "Conversation" ], "summary": "=== Activity Log ===", "operationId": "get_api_v1_conversations_id_activity", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/agents": { "get": { "tags": [ "Conversation" ], "summary": "GET /:id/agents", "operationId": "get_api_v1_conversations_id_agents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Conversation" ], "summary": "=== Agents ===", "operationId": "post_api_v1_conversations_id_agents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string", "example": "string" }, "agent_id": { "type": "string", "example": "string" } } }, "example": { "agentId": "string", "agent_id": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/agents/{agentId}": { "delete": { "tags": [ "Conversation" ], "summary": "DELETE /:id/agents/:agentId", "operationId": "delete_api_v1_conversations_id_agents_agentId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "agentId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/assign": { "post": { "tags": [ "Conversation" ], "summary": "Assign agent to conversation", "operationId": "post_api_v1_conversations_id_assign", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string", "example": "string" } }, "required": [ "agentId" ] }, "example": { "agentId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/labels": { "get": { "tags": [ "Conversation" ], "summary": "=== Labels ===", "operationId": "get_api_v1_conversations_id_labels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Conversation" ], "summary": "POST /:id/labels", "operationId": "post_api_v1_conversations_id_labels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "labelId": { "type": "string", "example": "string" } }, "required": [ "labelId" ] }, "example": { "labelId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/labels/{labelId}": { "delete": { "tags": [ "Conversation" ], "summary": "DELETE /:id/labels/:labelId", "operationId": "delete_api_v1_conversations_id_labels_labelId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "labelId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/messages": { "get": { "tags": [ "Conversation" ], "summary": "Get conversation messages", "operationId": "get_api_v1_conversations_id_messages", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Conversation" ], "summary": "POST /:id/messages", "operationId": "post_api_v1_conversations_id_messages", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/notes": { "get": { "tags": [ "Conversation" ], "summary": "=== Notes ===", "operationId": "get_api_v1_conversations_id_notes", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Conversation" ], "summary": "POST /:id/notes", "operationId": "post_api_v1_conversations_id_notes", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "example": "string" } }, "required": [ "content" ] }, "example": { "content": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/notes/{noteId}": { "patch": { "tags": [ "Conversation" ], "summary": "PATCH /:id/notes/:noteId", "operationId": "patch_api_v1_conversations_id_notes_noteId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "example": "string" } }, "required": [ "content" ] }, "example": { "content": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/read": { "post": { "tags": [ "Conversation" ], "summary": "Mark conversation as read", "operationId": "post_api_v1_conversations_id_read", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/resolve": { "post": { "tags": [ "Conversation" ], "summary": "Resolve conversation (shortcut)", "operationId": "post_api_v1_conversations_id_resolve", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/status": { "patch": { "tags": [ "Conversation" ], "summary": "Update conversation status (PATCH)", "operationId": "patch_api_v1_conversations_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "string" } }, "required": [ "status" ] }, "example": { "status": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Conversation" ], "summary": "Update conversation status (POST — frontend uses POST)", "operationId": "post_api_v1_conversations_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "string" } }, "required": [ "status" ] }, "example": { "status": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/{id}/takeover": { "post": { "tags": [ "Conversation" ], "summary": "Take over conversation with current authenticated agent", "operationId": "post_api_v1_conversations_id_takeover", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string", "example": "string" }, "agent_id": { "type": "string", "example": "string" } } }, "example": { "agentId": "string", "agent_id": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/bulk-edit": { "post": { "tags": [ "Conversation" ], "summary": "Queue bulk-edit conversation actions", "operationId": "post_api_v1_conversations_bulk_edit", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "conversationIds": { "type": "string", "example": "string" }, "collaboratorIds": { "type": "string", "example": "string" }, "handledById": { "type": "string", "example": "string" }, "labelId": { "type": "string", "example": "string" }, "pipelineStageId": { "type": "string", "example": "string" }, "resolveStatus": { "type": "string", "example": "open" } }, "required": [ "conversationIds" ] }, "example": { "conversationIds": "string", "collaboratorIds": "string", "handledById": "string", "labelId": "string", "pipelineStageId": "string", "resolveStatus": "open" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/bulk-edit/{jobId}": { "get": { "tags": [ "Conversation" ], "summary": "Get bulk-edit job status", "operationId": "get_api_v1_conversations_bulk_edit_jobId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/conversations/counts": { "get": { "tags": [ "Conversation" ], "summary": "Get conversation status counts", "operationId": "get_api_v1_conversations_counts", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/crm/deals": { "get": { "tags": [ "CRM" ], "summary": "GET /deals", "operationId": "get_api_v1_crm_deals", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "pipelineId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/crm/deals/{conversationId}": { "get": { "tags": [ "CRM" ], "summary": "GET /deals/:conversationId", "operationId": "get_api_v1_crm_deals_conversationId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "CRM" ], "summary": "PATCH /deals/:conversationId", "operationId": "patch_api_v1_crm_deals_conversationId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/crm/pipelines": { "get": { "tags": [ "CRM" ], "summary": "GET /pipelines", "operationId": "get_api_v1_crm_pipelines", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "CRM" ], "summary": "POST /pipelines", "operationId": "post_api_v1_crm_pipelines", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/crm/pipelines/{id}": { "delete": { "tags": [ "CRM" ], "summary": "DELETE /pipelines/:id", "operationId": "delete_api_v1_crm_pipelines_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/customers": { "get": { "tags": [ "Customer" ], "summary": "GET /", "operationId": "get_api_v1_customers", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "pipeline_stage_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "consent_status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "tag_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "channel", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/customers/{id}": { "get": { "tags": [ "Customer" ], "summary": "GET /:id", "operationId": "get_api_v1_customers_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "Customer" ], "summary": "PUT /:id", "operationId": "put_api_v1_customers_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "*": { "type": "string", "example": { "key": "value" } } } }, "example": { "key": "value" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/customers/{id}/tags": { "post": { "tags": [ "Customer" ], "summary": "POST /:id/tags", "operationId": "post_api_v1_customers_id_tags", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tag_id": { "type": "string", "example": "string" }, "tag_name": { "type": "string", "example": "string" } } }, "example": { "tag_id": "string", "tag_name": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/customers/{id}/tags/{tagId}": { "delete": { "tags": [ "Customer" ], "summary": "DELETE /:id/tags/:tagId", "operationId": "delete_api_v1_customers_id_tags_tagId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/customers/stats": { "get": { "tags": [ "Customer" ], "summary": "GET /stats", "operationId": "get_api_v1_customers_stats", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/flows": { "get": { "tags": [ "Flow" ], "summary": "GET /", "operationId": "get_api_v1_flows", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Flow" ], "summary": "POST /", "operationId": "post_api_v1_flows", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/flows/{id}": { "delete": { "tags": [ "Flow" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_flows_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Flow" ], "summary": "GET /:id", "operationId": "get_api_v1_flows_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Flow" ], "summary": "PATCH /:id", "operationId": "patch_api_v1_flows_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/flows/{id}/activate": { "post": { "tags": [ "Flow" ], "summary": "POST /:id/activate", "operationId": "post_api_v1_flows_id_activate", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/forms": { "get": { "tags": [ "Advanced" ], "summary": "GET /", "operationId": "get_api_v1_forms", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Advanced" ], "summary": "POST /", "operationId": "post_api_v1_forms", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/forms/{id}": { "get": { "tags": [ "Advanced" ], "summary": "GET /:id", "operationId": "get_api_v1_forms_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/forms/conversation/{id}": { "get": { "tags": [ "Advanced" ], "summary": "GET /conversation/:id", "operationId": "get_api_v1_forms_conversation_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/forms/conversation/{id}/extract": { "post": { "tags": [ "Advanced" ], "summary": "POST /conversation/:id/extract", "operationId": "post_api_v1_forms_conversation_id_extract", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/inboxes": { "get": { "tags": [ "Inbox" ], "summary": "GET /", "operationId": "get_api_v1_inboxes", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Inbox" ], "summary": "POST /", "operationId": "post_api_v1_inboxes", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/inboxes/{id}": { "delete": { "tags": [ "Inbox" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_inboxes_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Inbox" ], "summary": "GET /:id", "operationId": "get_api_v1_inboxes_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Inbox" ], "summary": "PATCH /:id", "operationId": "patch_api_v1_inboxes_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/instagram-channels": { "get": { "tags": [ "Instagram" ], "summary": "GET /", "operationId": "get_api_v1_instagram_channels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/instagram-channels/{id}": { "delete": { "tags": [ "Instagram" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_instagram_channels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/instagram-channels/{id}/status": { "get": { "tags": [ "Instagram" ], "summary": "GET /:id/status", "operationId": "get_api_v1_instagram_channels_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/instagram-channels/callback": { "get": { "tags": [ "Instagram" ], "summary": "GET /callback", "operationId": "get_api_v1_instagram_channels_callback", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.mode", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.verify_token", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.challenge", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Instagram" ], "summary": "Instagram Webhook Payload (POST) - receives DMs, comments, etc.", "operationId": "post_api_v1_instagram_channels_callback", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/instagram-channels/init-login": { "post": { "tags": [ "Instagram" ], "summary": "POST /init-login", "operationId": "post_api_v1_instagram_channels_init_login", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/knowledge/categories": { "get": { "tags": [ "Knowledge" ], "summary": "Categories", "operationId": "get_api_v1_knowledge_categories", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "chatbotId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Knowledge" ], "summary": "POST /categories", "operationId": "post_api_v1_knowledge_categories", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/knowledge/categories/{id}": { "delete": { "tags": [ "Knowledge" ], "summary": "DELETE /categories/:id", "operationId": "delete_api_v1_knowledge_categories_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/knowledge/faqs": { "get": { "tags": [ "Knowledge" ], "summary": "FAQs", "operationId": "get_api_v1_knowledge_faqs", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "chatbotId", "in": "query", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "categoryId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Knowledge" ], "summary": "POST /faqs", "operationId": "post_api_v1_knowledge_faqs", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/knowledge/faqs/{id}": { "delete": { "tags": [ "Knowledge" ], "summary": "DELETE /faqs/:id", "operationId": "delete_api_v1_knowledge_faqs_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Knowledge" ], "summary": "PATCH /faqs/:id", "operationId": "patch_api_v1_knowledge_faqs_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/knowledge/sources": { "get": { "tags": [ "Knowledge" ], "summary": "Sources (Mapped from FAQs for now or create service for it)", "operationId": "get_api_v1_knowledge_sources", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "chatbotId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "categoryId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/knowledge/stats": { "get": { "tags": [ "Knowledge" ], "summary": "Stats", "operationId": "get_api_v1_knowledge_stats", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "chatbotId", "in": "query", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/labels": { "get": { "tags": [ "Label" ], "summary": "GET /", "operationId": "get_api_v1_labels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Label" ], "summary": "POST /", "operationId": "post_api_v1_labels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/labels/{id}": { "delete": { "tags": [ "Label" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_labels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Label" ], "summary": "PATCH /:id", "operationId": "patch_api_v1_labels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/labels/conversation/{id}": { "get": { "tags": [ "Label" ], "summary": "Conversation Labels", "operationId": "get_api_v1_labels_conversation_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Label" ], "summary": "POST /conversation/:id", "operationId": "post_api_v1_labels_conversation_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "labelId": { "type": "string", "example": "string" } }, "required": [ "labelId" ] }, "example": { "labelId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/labels/conversation/{id}/{labelId}": { "delete": { "tags": [ "Label" ], "summary": "DELETE /conversation/:id/:labelId", "operationId": "delete_api_v1_labels_conversation_id_labelId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "labelId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/media/gallery": { "get": { "tags": [ "Media" ], "summary": "GET /gallery", "operationId": "get_api_v1_media_gallery", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "take", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/media/upload": { "post": { "tags": [ "Media" ], "summary": "POST /upload", "operationId": "post_api_v1_media_upload", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "example": "" }, "platform": { "type": "string", "example": "string" } }, "required": [ "file" ] }, "example": { "file": "", "platform": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/messages": { "post": { "tags": [ "Message" ], "summary": "Send a message", "operationId": "post_api_v1_messages", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "conversationId": { "type": "string", "example": "string" }, "senderId": { "type": "string", "example": "string" }, "content": { "type": "string", "example": "string" }, "contentType": { "type": "string", "example": "string" }, "mediaIds": { "type": "string", "example": "string" } }, "required": [ "conversationId", "content" ] }, "example": { "conversationId": "string", "senderId": "string", "content": "string", "contentType": "string", "mediaIds": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/messages/{id}": { "delete": { "tags": [ "Message" ], "summary": "Delete message (soft delete)", "operationId": "delete_api_v1_messages_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Message" ], "summary": "Get message by ID", "operationId": "get_api_v1_messages_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/messages/{id}/status": { "patch": { "tags": [ "Message" ], "summary": "Update message status", "operationId": "patch_api_v1_messages_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "string" }, "externalId": { "type": "string", "example": "string" } }, "required": [ "status" ] }, "example": { "status": "string", "externalId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/meta-ads/accounts": { "get": { "tags": [ "Admin" ], "summary": "GET /accounts", "operationId": "get_api_v1_meta_ads_accounts", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/meta-ads/campaigns": { "get": { "tags": [ "Admin" ], "summary": "GET /campaigns", "operationId": "get_api_v1_meta_ads_campaigns", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/meta-ads/insights/summary": { "get": { "tags": [ "Admin" ], "summary": "GET /insights/summary", "operationId": "get_api_v1_meta_ads_insights_summary", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/metrics/ai": { "get": { "tags": [ "Advanced" ], "summary": "GET /ai", "operationId": "get_api_v1_metrics_ai", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/metrics/dashboard": { "get": { "tags": [ "Advanced" ], "summary": "GET /dashboard", "operationId": "get_api_v1_metrics_dashboard", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/metrics/summary": { "get": { "tags": [ "Advanced" ], "summary": "GET /summary", "operationId": "get_api_v1_metrics_summary", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/orchestration/agents": { "get": { "tags": [ "AI" ], "summary": "GET /agents", "operationId": "get_api_v1_orchestration_agents", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/orchestration/decide": { "post": { "tags": [ "AI" ], "summary": "POST /decide", "operationId": "post_api_v1_orchestration_decide", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/orchestration/handoff": { "post": { "tags": [ "AI" ], "summary": "POST /handoff", "operationId": "post_api_v1_orchestration_handoff", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/orchestration/handoffs/{conversationId}": { "get": { "tags": [ "AI" ], "summary": "GET /handoffs/:conversationId", "operationId": "get_api_v1_orchestration_handoffs_conversationId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/orders": { "get": { "tags": [ "Orders" ], "summary": "GET /", "operationId": "get_api_v1_orders", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "payment_type", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "order_status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "inbox_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "sort_field", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "sort_direction", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "include_conv", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/orders/report": { "get": { "tags": [ "Orders" ], "summary": "GET /report", "operationId": "get_api_v1_orders_report", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/orders/subscriptions": { "get": { "tags": [ "Orders" ], "summary": "GET /subscriptions", "operationId": "get_api_v1_orders_subscriptions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "sort_field", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "sort_direction", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/companies": { "get": { "tags": [ "Super Admin" ], "summary": "GET /companies", "operationId": "get_api_v1_super_admin_companies", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/companies/{id}/status": { "patch": { "tags": [ "Super Admin" ], "summary": "PATCH /companies/:id/status", "operationId": "patch_api_v1_super_admin_companies_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/companies/{id}/top-up": { "post": { "tags": [ "Super Admin" ], "summary": "POST /companies/:id/top-up", "operationId": "post_api_v1_super_admin_companies_id_top_up", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/credits/adjust": { "post": { "tags": [ "Super Admin" ], "summary": "POST /credits/adjust", "operationId": "post_api_v1_super_admin_credits_adjust", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/credits/balance/{orgId}": { "get": { "tags": [ "Super Admin" ], "summary": "GET /credits/balance/:orgId", "operationId": "get_api_v1_super_admin_credits_balance_orgId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/credits/model-pricing": { "get": { "tags": [ "Super Admin" ], "summary": "GET /credits/model-pricing", "operationId": "get_api_v1_super_admin_credits_model_pricing", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Super Admin" ], "summary": "POST /credits/model-pricing", "operationId": "post_api_v1_super_admin_credits_model_pricing", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/credits/packages": { "get": { "tags": [ "Super Admin" ], "summary": "GET /credits/packages", "operationId": "get_api_v1_super_admin_credits_packages", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/reports/usage": { "get": { "tags": [ "Super Admin" ], "summary": "GET /reports/usage", "operationId": "get_api_v1_super_admin_reports_usage", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/stats": { "get": { "tags": [ "Super Admin" ], "summary": "GET /stats", "operationId": "get_api_v1_super_admin_stats", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/users": { "get": { "tags": [ "Super Admin" ], "summary": "GET /users", "operationId": "get_api_v1_super_admin_users", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/users/{id}/role": { "patch": { "tags": [ "Super Admin" ], "summary": "PATCH /users/:id/role", "operationId": "patch_api_v1_super_admin_users_id_role", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/users/{id}/suspend": { "post": { "tags": [ "Super Admin" ], "summary": "POST /users/:id/suspend", "operationId": "post_api_v1_super_admin_users_id_suspend", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/super-admin/webhooks": { "get": { "tags": [ "Super Admin" ], "summary": "GET /webhooks", "operationId": "get_api_v1_super_admin_webhooks", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/teams": { "get": { "tags": [ "Team" ], "summary": "GET /", "operationId": "get_api_v1_teams", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Team" ], "summary": "POST /", "operationId": "post_api_v1_teams", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/teams/{id}": { "delete": { "tags": [ "Team" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_teams_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Team" ], "summary": "GET /:id", "operationId": "get_api_v1_teams_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Team" ], "summary": "PATCH /:id", "operationId": "patch_api_v1_teams_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/teams/{id}/members": { "post": { "tags": [ "Team" ], "summary": "POST /:id/members", "operationId": "post_api_v1_teams_id_members", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "example": "string" } }, "required": [ "userId" ] }, "example": { "userId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/teams/{id}/members/{userId}": { "delete": { "tags": [ "Team" ], "summary": "DELETE /:id/members/:userId", "operationId": "delete_api_v1_teams_id_members_userId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/template-variables": { "get": { "tags": [ "Template Variables" ], "summary": "GET /", "operationId": "get_api_v1_template_variables", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Template Variables" ], "summary": "POST /", "operationId": "post_api_v1_template_variables", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/template-variables/{id}": { "delete": { "tags": [ "Template Variables" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_template_variables_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/templates": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /templates", "operationId": "get_api_v1_templates", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "channelId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/templates/sync": { "post": { "tags": [ "WhatsApp" ], "summary": "POST /templates/sync", "operationId": "post_api_v1_templates_sync", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channelId": { "type": "string", "example": "string" } } }, "example": { "channelId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/tickets/conversations/{conversationId}": { "get": { "tags": [ "Tickets" ], "summary": "GET /conversations/:conversationId", "operationId": "get_api_v1_tickets_conversations_conversationId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } }, { "name": "board_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Tickets" ], "summary": "PATCH /conversations/:conversationId", "operationId": "patch_api_v1_tickets_conversations_conversationId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/tickets/conversations/{conversationId}/move": { "post": { "tags": [ "Tickets" ], "summary": "POST /conversations/:conversationId/move", "operationId": "post_api_v1_tickets_conversations_conversationId_move", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/tickets/conversations/{conversationId}/status": { "patch": { "tags": [ "Tickets" ], "summary": "PATCH /conversations/:conversationId/status", "operationId": "patch_api_v1_tickets_conversations_conversationId_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/tickets/kanban": { "post": { "tags": [ "Tickets" ], "summary": "POST /kanban", "operationId": "post_api_v1_tickets_kanban", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/tickets/settings": { "get": { "tags": [ "Tickets" ], "summary": "GET /settings", "operationId": "get_api_v1_tickets_settings", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/tickets/settings/default-board": { "put": { "tags": [ "Tickets" ], "summary": "PUT /settings/default-board", "operationId": "put_api_v1_tickets_settings_default_board", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/tiktok-channels": { "get": { "tags": [ "TikTok" ], "summary": "GET /", "operationId": "get_api_v1_tiktok_channels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/tiktok-channels/{id}": { "delete": { "tags": [ "TikTok" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_tiktok_channels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/tiktok-channels/{id}/status": { "get": { "tags": [ "TikTok" ], "summary": "GET /:id/status", "operationId": "get_api_v1_tiktok_channels_id_status", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/tiktok-channels/callback": { "get": { "tags": [ "TikTok" ], "summary": "GET /callback", "operationId": "get_api_v1_tiktok_channels_callback", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/tiktok-channels/init-login": { "post": { "tags": [ "TikTok" ], "summary": "POST /init-login", "operationId": "post_api_v1_tiktok_channels_init_login", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/tiktok-channels/redirect_uri": { "get": { "tags": [ "TikTok" ], "summary": "GET redirect_uri", "operationId": "get_api_v1_tiktok_channels_redirect_uri", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/user": { "get": { "tags": [ "User" ], "summary": "Get all users for an account", "operationId": "get_api_v1_user", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/user/{id}": { "get": { "tags": [ "User" ], "summary": "Get user by ID", "operationId": "get_api_v1_user_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "User" ], "summary": "Update user profile", "operationId": "patch_api_v1_user_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/user/{id}/presence": { "get": { "tags": [ "User" ], "summary": "Get user presence", "operationId": "get_api_v1_user_id_presence", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "User" ], "summary": "Update user presence", "operationId": "post_api_v1_user_id_presence", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "string" } }, "required": [ "status" ] }, "example": { "status": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/user/timezone": { "get": { "tags": [ "User" ], "summary": "Get user timezone", "operationId": "get_api_v1_user_timezone", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "put": { "tags": [ "User" ], "summary": "Update user timezone", "operationId": "put_api_v1_user_timezone", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "example": "string" } }, "required": [ "timezone" ] }, "example": { "timezone": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/user/timezone/detect": { "post": { "tags": [ "User" ], "summary": "Detect user timezone", "operationId": "post_api_v1_user_timezone_detect", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "detected_timezone": { "type": "string", "example": "string" } } }, "example": { "detected_timezone": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/user/timezone/reset": { "post": { "tags": [ "User" ], "summary": "Reset user timezone", "operationId": "post_api_v1_user_timezone_reset", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/waba/connect/manual": { "post": { "tags": [ "WABA" ], "summary": "POST /connect/manual", "operationId": "post_api_v1_waba_connect_manual", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/waba/webhook-config": { "get": { "tags": [ "WABA" ], "summary": "GET /webhook-config", "operationId": "get_api_v1_waba_webhook_config", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/webhooks": { "get": { "tags": [ "Webhook" ], "summary": "Outbound Management", "operationId": "get_api_v1_webhooks", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Webhook" ], "summary": "POST /", "operationId": "post_api_v1_webhooks", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "example": "string" }, "name": { "type": "string", "example": "string" }, "events": { "type": "string", "example": "string" } }, "required": [ "url" ] }, "example": { "url": "string", "name": "string", "events": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/webhooks/{id}": { "delete": { "tags": [ "Webhook" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_webhooks_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/webhooks/instagram": { "get": { "tags": [ "Webhook" ], "summary": "GET /instagram", "operationId": "get_api_v1_webhooks_instagram", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "hub.mode", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.verify_token", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.challenge", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Webhook" ], "summary": "POST /instagram", "operationId": "post_api_v1_webhooks_instagram", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/webhooks/tiktok": { "get": { "tags": [ "Webhook" ], "summary": "GET /tiktok", "operationId": "get_api_v1_webhooks_tiktok", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "challenge", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "verify_token", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.mode", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.verify_token", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.challenge", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Webhook" ], "summary": "POST /tiktok", "operationId": "post_api_v1_webhooks_tiktok", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/webhooks/whatsapp": { "get": { "tags": [ "Webhook" ], "summary": "Meta Webhook Verification (GET)", "operationId": "get_api_v1_webhooks_whatsapp", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "hub.mode", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.verify_token", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.challenge", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Webhook" ], "summary": "Meta Webhook Payloads (POST)", "operationId": "post_api_v1_webhooks_whatsapp", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/webhooks/whatsapp/media/{messageId}": { "get": { "tags": [ "Webhook" ], "summary": "GET /whatsapp/media/:messageId", "operationId": "get_api_v1_webhooks_whatsapp_media_messageId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/whatsapp-channels": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /", "operationId": "get_api_v1_whatsapp_channels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "WhatsApp" ], "summary": "POST /", "operationId": "post_api_v1_whatsapp_channels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/whatsapp-channels/{id}": { "delete": { "tags": [ "WhatsApp" ], "summary": "DELETE /:id", "operationId": "delete_api_v1_whatsapp_channels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "WhatsApp" ], "summary": "GET /:id", "operationId": "get_api_v1_whatsapp_channels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "WhatsApp" ], "summary": "PATCH /:id", "operationId": "patch_api_v1_whatsapp_channels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/whatsapp-channels/{id}/badge": { "delete": { "tags": [ "WhatsApp" ], "summary": "DELETE /:id/badge", "operationId": "delete_api_v1_whatsapp_channels_id_badge", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "WhatsApp" ], "summary": "POST /:id/badge", "operationId": "post_api_v1_whatsapp_channels_id_badge", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "badge": { "type": "string", "example": "" } }, "required": [ "badge" ] }, "example": { "badge": "" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/whatsapp-channels/{id}/details": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /:id/details", "operationId": "get_api_v1_whatsapp_channels_id_details", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/whatsapp-channels/callback": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /callback", "operationId": "get_api_v1_whatsapp_channels_callback", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "waba_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "whatsapp_business_account_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "phone_number_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "phone_number_ids", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/whatsapp-channels/config": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /config", "operationId": "get_api_v1_whatsapp_channels_config", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/whatsapp-channels/exchange-token": { "post": { "tags": [ "WhatsApp" ], "summary": "POST /exchange-token", "operationId": "post_api_v1_whatsapp_channels_exchange_token", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/v1/whatsapp-channels/init-signup": { "post": { "tags": [ "WhatsApp" ], "summary": "POST /init-signup", "operationId": "post_api_v1_whatsapp_channels_init_signup", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/volara/chat/webhooks/subscriptions": { "get": { "tags": [ "Volara Compatibility" ], "summary": "GET /chat/webhooks/subscriptions", "operationId": "get_api_volara_chat_webhooks_subscriptions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Volara Compatibility" ], "summary": "POST /chat/webhooks/subscriptions", "operationId": "post_api_volara_chat_webhooks_subscriptions", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/volara/chat/webhooks/subscriptions/{id}": { "delete": { "tags": [ "Volara Compatibility" ], "summary": "DELETE /chat/webhooks/subscriptions/:id", "operationId": "delete_api_volara_chat_webhooks_subscriptions_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/volara/orders": { "get": { "tags": [ "Volara Compatibility" ], "summary": "GET /orders", "operationId": "get_api_volara_orders", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Volara Compatibility" ], "summary": "POST /orders", "operationId": "post_api_volara_orders", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/volara/orders/{id}": { "get": { "tags": [ "Volara Compatibility" ], "summary": "GET /orders/:id", "operationId": "get_api_volara_orders_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "Volara Compatibility" ], "summary": "PATCH /orders/:id", "operationId": "patch_api_volara_orders_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/volara/users": { "get": { "tags": [ "Volara Compatibility" ], "summary": "GET /users", "operationId": "get_api_volara_users", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/volara/workflows": { "get": { "tags": [ "Volara Compatibility" ], "summary": "GET /workflows", "operationId": "get_api_volara_workflows", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/volara/workflows/{id}/hook": { "delete": { "tags": [ "Volara Compatibility" ], "summary": "DELETE /workflows/:id/hook", "operationId": "delete_api_volara_workflows_id_hook", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "Volara Compatibility" ], "summary": "GET /workflows/:id/hook", "operationId": "get_api_volara_workflows_id_hook", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Volara Compatibility" ], "summary": "POST /workflows/:id/hook", "operationId": "post_api_volara_workflows_id_hook", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/waba/connect/manual": { "post": { "tags": [ "WABA" ], "summary": "POST /connect/manual", "operationId": "post_api_waba_connect_manual", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/waba/webhook-config": { "get": { "tags": [ "WABA" ], "summary": "GET /webhook-config", "operationId": "get_api_waba_webhook_config", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/webhooks": { "get": { "tags": [ "Webhook" ], "summary": "Outbound Management", "operationId": "get_api_webhooks", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Webhook" ], "summary": "POST /", "operationId": "post_api_webhooks", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "example": "string" }, "name": { "type": "string", "example": "string" }, "events": { "type": "string", "example": "string" } }, "required": [ "url" ] }, "example": { "url": "string", "name": "string", "events": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/webhooks/{id}": { "delete": { "tags": [ "Webhook" ], "summary": "DELETE /:id", "operationId": "delete_api_webhooks_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/webhooks/instagram": { "get": { "tags": [ "Webhook" ], "summary": "GET /instagram", "operationId": "get_api_webhooks_instagram", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "hub.mode", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.verify_token", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.challenge", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Webhook" ], "summary": "POST /instagram", "operationId": "post_api_webhooks_instagram", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/webhooks/tiktok": { "get": { "tags": [ "Webhook" ], "summary": "GET /tiktok", "operationId": "get_api_webhooks_tiktok", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "challenge", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "verify_token", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.mode", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.verify_token", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.challenge", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Webhook" ], "summary": "POST /tiktok", "operationId": "post_api_webhooks_tiktok", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/webhooks/whatsapp": { "get": { "tags": [ "Webhook" ], "summary": "Meta Webhook Verification (GET)", "operationId": "get_api_webhooks_whatsapp", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "hub.mode", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.verify_token", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "hub.challenge", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "Webhook" ], "summary": "Meta Webhook Payloads (POST)", "operationId": "post_api_webhooks_whatsapp", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/webhooks/whatsapp/media/{messageId}": { "get": { "tags": [ "Webhook" ], "summary": "GET /whatsapp/media/:messageId", "operationId": "get_api_webhooks_whatsapp_media_messageId", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /", "operationId": "get_api_whatsapp", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "WhatsApp" ], "summary": "POST /", "operationId": "post_api_whatsapp", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp-channels": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /", "operationId": "get_api_whatsapp_channels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "WhatsApp" ], "summary": "POST /", "operationId": "post_api_whatsapp_channels", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp-channels/{id}": { "delete": { "tags": [ "WhatsApp" ], "summary": "DELETE /:id", "operationId": "delete_api_whatsapp_channels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "WhatsApp" ], "summary": "GET /:id", "operationId": "get_api_whatsapp_channels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "WhatsApp" ], "summary": "PATCH /:id", "operationId": "patch_api_whatsapp_channels_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp-channels/{id}/badge": { "delete": { "tags": [ "WhatsApp" ], "summary": "DELETE /:id/badge", "operationId": "delete_api_whatsapp_channels_id_badge", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "WhatsApp" ], "summary": "POST /:id/badge", "operationId": "post_api_whatsapp_channels_id_badge", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "badge": { "type": "string", "example": "" } }, "required": [ "badge" ] }, "example": { "badge": "" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp-channels/{id}/details": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /:id/details", "operationId": "get_api_whatsapp_channels_id_details", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp-channels/callback": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /callback", "operationId": "get_api_whatsapp_channels_callback", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "waba_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "whatsapp_business_account_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "phone_number_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "phone_number_ids", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp-channels/config": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /config", "operationId": "get_api_whatsapp_channels_config", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp-channels/exchange-token": { "post": { "tags": [ "WhatsApp" ], "summary": "POST /exchange-token", "operationId": "post_api_whatsapp_channels_exchange_token", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp-channels/init-signup": { "post": { "tags": [ "WhatsApp" ], "summary": "POST /init-signup", "operationId": "post_api_whatsapp_channels_init_signup", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp/{id}": { "delete": { "tags": [ "WhatsApp" ], "summary": "DELETE /:id", "operationId": "delete_api_whatsapp_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "get": { "tags": [ "WhatsApp" ], "summary": "GET /:id", "operationId": "get_api_whatsapp_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "patch": { "tags": [ "WhatsApp" ], "summary": "PATCH /:id", "operationId": "patch_api_whatsapp_id", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp/{id}/badge": { "delete": { "tags": [ "WhatsApp" ], "summary": "DELETE /:id/badge", "operationId": "delete_api_whatsapp_id_badge", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] }, "post": { "tags": [ "WhatsApp" ], "summary": "POST /:id/badge", "operationId": "post_api_whatsapp_id_badge", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "badge": { "type": "string", "example": "" } }, "required": [ "badge" ] }, "example": { "badge": "" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp/{id}/details": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /:id/details", "operationId": "get_api_whatsapp_id_details", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp/callback": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /callback", "operationId": "get_api_whatsapp_callback", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "code", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "waba_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "whatsapp_business_account_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "phone_number_id", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "phone_number_ids", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp/config": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /config", "operationId": "get_api_whatsapp_config", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp/exchange-token": { "post": { "tags": [ "WhatsApp" ], "summary": "POST /exchange-token", "operationId": "post_api_whatsapp_exchange_token", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp/init-signup": { "post": { "tags": [ "WhatsApp" ], "summary": "POST /init-signup", "operationId": "post_api_whatsapp_init_signup", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp/templates": { "get": { "tags": [ "WhatsApp" ], "summary": "GET /templates", "operationId": "get_api_whatsapp_templates", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "parameters": [ { "name": "appId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } }, { "name": "channelId", "in": "query", "required": false, "schema": { "type": "string", "example": "string" } } ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/api/whatsapp/templates/sync": { "post": { "tags": [ "WhatsApp" ], "summary": "POST /templates/sync", "operationId": "post_api_whatsapp_templates_sync", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "channelId": { "type": "string", "example": "string" } } }, "example": { "channelId": "string" } } } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/auth/session": { "get": { "tags": [ "Better Auth" ], "summary": "Read active Better Auth session", "operationId": "get_auth_session", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/auth/sign-in/email": { "post": { "tags": [ "Better Auth" ], "summary": "Better Auth email/password sign in", "operationId": "post_auth_sign_in_email", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "user@example.com" }, "password": { "type": "string", "example": "password" } }, "required": [ "email", "password" ] }, "example": { "email": "user@example.com", "password": "password" } } } } } }, "/auth/sign-out": { "post": { "tags": [ "Better Auth" ], "summary": "Sign out active Better Auth session", "operationId": "post_auth_sign_out", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ] } }, "/auth/sign-up/email": { "post": { "tags": [ "Better Auth" ], "summary": "Better Auth email/password registration", "operationId": "post_auth_sign_up_email", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "user@example.com" }, "password": { "type": "string", "example": "password" }, "name": { "type": "string", "example": "User Name" } }, "required": [ "email", "password" ] }, "example": { "email": "user@example.com", "password": "password", "name": "User Name" } } } } } }, "/health": { "get": { "tags": [ "System" ], "summary": "Worker health check", "operationId": "get_health", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "429": { "description": "Too Many Requests" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "API key developer: `Authorization: Bearer `" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "Alternatif header: `x-api-key: `" } } } }