{ "info": { "name": "Sulus API", "description": "Every documented Sulus API module in one collection.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://app.sulus.ai", "type": "string", "description": "Your Sulus base URL (no trailing path — each request carries its own API base path)" }, { "key": "token", "value": "", "type": "string", "description": "Personal access token from /developer (format: 1234|abcd...)" }, { "key": "assistantId", "value": "", "type": "string" }, { "key": "entryId", "value": "", "type": "string" }, { "key": "id", "value": "", "type": "string" }, { "key": "knowledge_base", "value": "", "type": "string" }, { "key": "article", "value": "", "type": "string" }, { "key": "agent_id", "value": "", "type": "string" }, { "key": "chat_id", "value": "", "type": "string" }, { "key": "file_id", "value": "", "type": "string" }, { "key": "connector_id", "value": "", "type": "string" }, { "key": "callId", "value": "", "type": "string" }, { "key": "connection", "value": "", "type": "string" }, { "key": "workspace", "value": "", "type": "string" }, { "key": "member", "value": "", "type": "string" }, { "key": "invitation", "value": "", "type": "string" }, { "key": "token", "value": "", "type": "string" } ], "item": [ { "name": "Assistants", "description": "How the voice-assistant system works — the endpoints, fields, validation rules, storage columns and limits behind creating and managing assistants, their advanced configuration, embed widget, and version history.", "item": [ { "name": "Assistants", "item": [ { "name": "List assistants you can access", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants", "host": [ "{{base_url}}" ], "path": [ "api", "assistants" ], "query": [ { "key": "search", "value": "", "description": "Filter by name. [string (name contains-filter)]", "disabled": true }, { "key": "phone_search", "value": "", "description": "Filter by phone number. [string (phone contains-filter)]", "disabled": true }, { "key": "sort_by", "value": "name", "description": "Sort field. [in: name, created_at, user_id (fallback name)]", "disabled": true }, { "key": "sort_order", "value": "asc", "description": "[asc|desc]", "disabled": true }, { "key": "per_page", "value": "9", "description": "Items per page. [integer]", "disabled": true }, { "key": "lite", "value": "", "description": "Returns a lightweight projection (id, name, vapi_assistant_id, type, model, voice, transcriber, first_message, voicemail_message, end_call_message) for pickers. [boolean]", "disabled": true } ] }, "description": "List assistants you can access" } }, { "name": "Create an assistant (writes to the live voice platform)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants", "host": [ "{{base_url}}" ], "path": [ "api", "assistants" ] }, "description": "Create an assistant (writes to the live voice platform)", "body": { "mode": "raw", "raw": "{\n \"name\": \"Reception\",\n \"type\": \"production\",\n \"selected_phone_number\": \"+14155550142\",\n \"user_id\": 17,\n \"template_id\": 5,\n \"firstMessage\": \"Thank you for calling {{companyName}}, this is {{personalityName}}. How can I help you today?\",\n \"firstMessageMode\": \"assistant-speaks-first\",\n \"firstMessageInterruptionsEnabled\": true,\n \"voicemailMessage\": \"Please leave a message after the tone and we'll call you back.\",\n \"endCallMessage\": \"Thank you for calling {{companyName}}, have a great day!\",\n \"endCallPhrases\": [\n \"goodbye\",\n \"that's all, thank you\"\n ],\n \"voicemailDetection\": {\n \"enabled\": true,\n \"beepDetection\": true,\n \"silenceDuration\": 10,\n \"greetingDuration\": 15\n },\n \"maxDurationSeconds\": 1800,\n \"backgroundSound\": \"office\",\n \"modelOutputInMessagesEnabled\": false,\n \"clientMessages\": [\n \"transcript\",\n \"status-update\"\n ],\n \"serverMessages\": [\n \"end-of-call-report\",\n \"status-update\"\n ],\n \"transportConfigurations\": [],\n \"transcriber\": {\n \"language\": \"en\",\n \"confidenceThreshold\": 0.4,\n \"formatTurns\": true\n },\n \"model\": {\n \"messages\": [\n {\n \"role\": \"system\",\n \"content\": \"You are Sarah, the AI voice receptionist for Acme Dental.\"\n }\n ],\n \"maxTokens\": 300,\n \"functionCall\": \"auto\",\n \"functionCallBehavior\": \"auto\",\n \"tools\": [\n \"c3d4e5f6-7a8b-49c0-8d1e-2f3a4b5c6d7e\"\n ]\n },\n \"voice\": {\n \"voiceId\": \"sarah-professional-01\",\n \"speed\": 1\n },\n \"compliancePlan\": {\n \"recordingEnabled\": true,\n \"transcriptionEnabled\": true,\n \"dataRetentionDays\": 365\n },\n \"backgroundSpeechDenoisingPlan\": {\n \"smartDenoising\": true,\n \"fourierDenoising\": false\n },\n \"startSpeakingPlan\": {\n \"initialDelayMs\": 400,\n \"backgroundSoundVolume\": 0.2\n },\n \"stopSpeakingPlan\": {\n \"initialDelayMs\": 0,\n \"backgroundSoundVolume\": 0.1\n },\n \"monitorPlan\": {\n \"listenEnabled\": false,\n \"controlEnabled\": false,\n \"websocketUrl\": null\n },\n \"keypadInputPlan\": {\n \"enabled\": false,\n \"maxDigits\": 4,\n \"terminateOnHash\": true\n },\n \"metadata\": {\n \"company_name\": \"Acme Dental\",\n \"industry\": \"Dental\",\n \"location\": \"Austin, TX\",\n \"services_products\": \"General and cosmetic dentistry, teeth whitening, emergency dental care\",\n \"sms_phone_number\": \"+14155550199\",\n \"assistant_phone_number\": \"+14155550142\",\n \"webhook_url\": \"https://automations.sulus.ai/webhook/lhg-live-demo-agents\"\n },\n \"variableValues\": {\n \"companyName\": \"Acme Dental\",\n \"industry\": \"Dental\",\n \"personalityName\": \"Sarah\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve one assistant", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants/{{assistantId}}", "host": [ "{{base_url}}" ], "path": [ "api", "assistants", "{{assistantId}}" ] }, "description": "Retrieve one assistant" } }, { "name": "Update an assistant (re-renders the prompt, syncs live)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants/{{assistantId}}", "host": [ "{{base_url}}" ], "path": [ "api", "assistants", "{{assistantId}}" ] }, "description": "Update an assistant (re-renders the prompt, syncs live)", "body": { "mode": "raw", "raw": "{\n \"name\": \"Reception\",\n \"type\": \"production\",\n \"template_id\": 5,\n \"firstMessage\": \"Hello! You have reached {{companyName}}, this is {{personalityName}}.\",\n \"firstMessageMode\": \"assistant-speaks-first\",\n \"firstMessageInterruptionsEnabled\": true,\n \"voicemailMessage\": \"Please leave a message after the tone and we'll call you back.\",\n \"endCallMessage\": \"Thank you for calling {{companyName}}, have a great day!\",\n \"endCallPhrases\": [\n \"goodbye\",\n \"that's all, thank you\"\n ],\n \"voicemailDetection\": {\n \"enabled\": true,\n \"beepDetection\": true,\n \"silenceDuration\": 10,\n \"greetingDuration\": 15\n },\n \"maxDurationSeconds\": 1800,\n \"backgroundSound\": \"office\",\n \"modelOutputInMessagesEnabled\": false,\n \"clientMessages\": [\n \"transcript\",\n \"status-update\"\n ],\n \"serverMessages\": [\n \"end-of-call-report\",\n \"status-update\"\n ],\n \"transportConfigurations\": [],\n \"transcriber\": {\n \"language\": \"en\",\n \"confidenceThreshold\": 0.4,\n \"formatTurns\": true\n },\n \"model\": {\n \"messages\": [\n {\n \"role\": \"system\",\n \"content\": \"You are Sarah, the AI voice receptionist for Acme Dental.\"\n }\n ],\n \"maxTokens\": 300,\n \"functionCall\": \"auto\",\n \"functionCallBehavior\": \"auto\",\n \"tools\": [\n \"c3d4e5f6-7a8b-49c0-8d1e-2f3a4b5c6d7e\"\n ]\n },\n \"voice\": {\n \"voiceId\": \"sarah-professional-01\",\n \"speed\": 1\n },\n \"compliancePlan\": {\n \"recordingEnabled\": true,\n \"transcriptionEnabled\": true,\n \"dataRetentionDays\": 365\n },\n \"backgroundSpeechDenoisingPlan\": {\n \"smartDenoising\": true,\n \"fourierDenoising\": false\n },\n \"startSpeakingPlan\": {\n \"initialDelayMs\": 400,\n \"backgroundSoundVolume\": 0.2\n },\n \"stopSpeakingPlan\": {\n \"initialDelayMs\": 0,\n \"backgroundSoundVolume\": 0.1\n },\n \"monitorPlan\": {\n \"listenEnabled\": false,\n \"controlEnabled\": false,\n \"websocketUrl\": null\n },\n \"keypadInputPlan\": {\n \"enabled\": false,\n \"maxDigits\": 4,\n \"terminateOnHash\": true\n },\n \"metadata\": {\n \"company_name\": \"Acme Dental\",\n \"industry\": \"Dental\",\n \"location\": \"Austin, TX\",\n \"services_products\": \"General and cosmetic dentistry, teeth whitening, emergency dental care\",\n \"sms_phone_number\": \"+14155550199\",\n \"assistant_phone_number\": \"+14155550142\",\n \"webhook_url\": \"https://automations.sulus.ai/webhook/lhg-live-demo-agents\",\n \"business_hours\": \"Mon-Fri 9:00 AM - 5:00 PM\"\n },\n \"variableValues\": {\n \"companyName\": \"Acme Dental\",\n \"industry\": \"Dental\",\n \"personalityName\": \"Sarah\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an assistant from the system and the live platform", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants/{{assistantId}}", "host": [ "{{base_url}}" ], "path": [ "api", "assistants", "{{assistantId}}" ] }, "description": "Delete an assistant from the system and the live platform" } }, { "name": "Tools available to attach to an assistant", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants/tools", "host": [ "{{base_url}}" ], "path": [ "api", "assistants", "tools" ], "query": [ { "key": "include", "value": "", "description": "Already-attached tool ids so their labels resolve even outside your scope. [array or comma-separated tool ids]", "disabled": true }, { "key": "owner_id", "value": "", "description": "List tools of the assistant's owner instead of the caller. [integer — honoured for admin roles only]", "disabled": true } ] }, "description": "Tools available to attach to an assistant" } } ] }, { "name": "Stats & history", "item": [ { "name": "Call statistics for the dashboard", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants/{{assistantId}}/stats", "host": [ "{{base_url}}" ], "path": [ "api", "assistants", "{{assistantId}}", "stats" ] }, "description": "Call statistics for the dashboard" } }, { "name": "Configuration version history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants/{{assistantId}}/update-log", "host": [ "{{base_url}}" ], "path": [ "api", "assistants", "{{assistantId}}", "update-log" ], "query": [ { "key": "limit", "value": "20", "description": "[integer, clamped 1–100]", "disabled": true }, { "key": "offset", "value": "0", "description": "[integer, min 0]", "disabled": true } ] }, "description": "Configuration version history" } }, { "name": "Restore a configuration from the version history", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants/{{assistantId}}/update-log/{{entryId}}/restore", "host": [ "{{base_url}}" ], "path": [ "api", "assistants", "{{assistantId}}", "update-log", "{{entryId}}", "restore" ] }, "description": "Restore a configuration from the version history" } } ] }, { "name": "Advanced editor", "item": [ { "name": "Full merged configuration for the advanced editor", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants/{{assistantId}}/advanced", "host": [ "{{base_url}}" ], "path": [ "api", "assistants", "{{assistantId}}", "advanced" ] }, "description": "Full merged configuration for the advanced editor" } }, { "name": "Update everything — regular fields plus the advanced set", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants/{{assistantId}}/advanced", "host": [ "{{base_url}}" ], "path": [ "api", "assistants", "{{assistantId}}", "advanced" ] }, "description": "Update everything — regular fields plus the advanced set", "body": { "mode": "raw", "raw": "{\n \"name\": \"Reception\",\n \"type\": \"production\",\n \"template_id\": 5,\n \"firstMessage\": \"Thank you for calling {{companyName}}, this is {{personalityName}}. How can I help you today?\",\n \"firstMessageMode\": \"assistant-speaks-first\",\n \"firstMessageInterruptionsEnabled\": true,\n \"voicemailMessage\": \"Please leave a message after the tone and we'll call you back.\",\n \"endCallMessage\": \"Thank you for calling {{companyName}}, have a great day!\",\n \"endCallPhrases\": [\n \"goodbye\",\n \"that's all, thank you\"\n ],\n \"voicemailDetection\": {\n \"enabled\": true,\n \"beepDetection\": true,\n \"silenceDuration\": 10,\n \"greetingDuration\": 15\n },\n \"maxDurationSeconds\": 1800,\n \"backgroundSound\": \"office\",\n \"modelOutputInMessagesEnabled\": false,\n \"clientMessages\": [\n \"transcript\",\n \"status-update\"\n ],\n \"serverMessages\": [\n \"end-of-call-report\",\n \"status-update\"\n ],\n \"transportConfigurations\": [],\n \"transcriber\": {\n \"language\": \"en\",\n \"confidenceThreshold\": 0.4,\n \"formatTurns\": true\n },\n \"model\": {\n \"messages\": [\n {\n \"role\": \"system\",\n \"content\": \"You are Sarah, the AI voice receptionist for Acme Dental.\"\n }\n ],\n \"maxTokens\": 300,\n \"functionCall\": \"auto\",\n \"functionCallBehavior\": \"auto\",\n \"tools\": [\n \"c3d4e5f6-7a8b-49c0-8d1e-2f3a4b5c6d7e\"\n ]\n },\n \"voice\": {\n \"voiceId\": \"sarah-professional-01\",\n \"speed\": 1\n },\n \"compliancePlan\": {\n \"recordingEnabled\": true,\n \"transcriptionEnabled\": true,\n \"dataRetentionDays\": 365\n },\n \"backgroundSpeechDenoisingPlan\": {\n \"smartDenoising\": true,\n \"fourierDenoising\": false\n },\n \"startSpeakingPlan\": {\n \"initialDelayMs\": 400,\n \"backgroundSoundVolume\": 0.2\n },\n \"stopSpeakingPlan\": {\n \"initialDelayMs\": 0,\n \"backgroundSoundVolume\": 0.1\n },\n \"monitorPlan\": {\n \"listenEnabled\": false,\n \"controlEnabled\": false,\n \"websocketUrl\": null\n },\n \"keypadInputPlan\": {\n \"enabled\": false,\n \"maxDigits\": 4,\n \"terminateOnHash\": true\n },\n \"metadata\": {\n \"company_name\": \"Acme Dental\",\n \"industry\": \"Dental\",\n \"location\": \"Austin, TX\",\n \"services_products\": \"General and cosmetic dentistry, teeth whitening, emergency dental care\",\n \"sms_phone_number\": \"+14155550199\",\n \"assistant_phone_number\": \"+14155550142\",\n \"webhook_url\": \"https://automations.sulus.ai/webhook/lhg-live-demo-agents\",\n \"sms_notifications\": [\n \"+14155550199\"\n ],\n \"email_notifications\": [\n \"owner@acmedental.com\"\n ]\n },\n \"variableValues\": {\n \"companyName\": \"Acme Dental\",\n \"industry\": \"Dental\",\n \"personalityName\": \"Sarah\"\n },\n \"analysisPlan\": {\n \"summaryPlan\": {\n \"enabled\": true\n }\n },\n \"artifactPlan\": {\n \"recording\": true,\n \"transcript\": true,\n \"summary\": true,\n \"analysis\": false\n },\n \"backgroundDenoisingEnabled\": true,\n \"personality_id\": 12,\n \"reseller_id\": 3\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Embed widget", "item": [ { "name": "Embed widget configuration + ready-to-paste HTML", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants/{{assistantId}}/embed", "host": [ "{{base_url}}" ], "path": [ "api", "assistants", "{{assistantId}}", "embed" ] }, "description": "Embed widget configuration + ready-to-paste HTML" } }, { "name": "Save the widget configuration", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants/{{assistantId}}/embed", "host": [ "{{base_url}}" ], "path": [ "api", "assistants", "{{assistantId}}", "embed" ] }, "description": "Save the widget configuration", "body": { "mode": "raw", "raw": "{\n \"embed_config\": {\n \"mode\": \"chat\",\n \"theme\": \"light\",\n \"position\": \"bottom-right\",\n \"size\": \"full\",\n \"radius\": \"medium\",\n \"chatStorage\": \"session\",\n \"chatStorageKey\": \"\",\n \"baseColor\": \"#FFFFFF\",\n \"accentColor\": \"#2563eb\",\n \"baseBgColor\": \"\",\n \"ctaButtonColor\": \"#000000\",\n \"ctaButtonTextColor\": \"#FFFFFF\",\n \"mainLabel\": \"Chat with Acme Dental\",\n \"ctaTitle\": \"Need help booking?\",\n \"ctaSubtitle\": \"We're online now.\",\n \"startButtonText\": \"Start\",\n \"endButtonText\": \"End Call\",\n \"emptyChatMessage\": \"Hi! How can I help you today?\",\n \"chatPlaceholder\": \"Type your message...\",\n \"firstChatMessage\": \"\",\n \"chatEndMessage\": \"\",\n \"emptyVoiceMessage\": \"\",\n \"emptyVoiceActiveMessage\": \"\",\n \"emptyHybridMessage\": \"\",\n \"showTranscript\": false,\n \"requireConsent\": true,\n \"consentTitle\": \"Before we start\",\n \"termsContent\": \"Calls and chats may be recorded for quality and training purposes.\"\n }\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Templates", "item": [ { "name": "Active prompt templates, optionally filtered by industry", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/assistants/prompt-templates/by-industry", "host": [ "{{base_url}}" ], "path": [ "api", "assistants", "prompt-templates", "by-industry" ], "query": [ { "key": "industry", "value": "", "description": "Industry filter. [string — empty returns all active templates]", "disabled": true } ] }, "description": "Active prompt templates, optionally filtered by industry" } } ] }, { "name": "v2 builder", "item": [ { "name": "List assistants with their v2 build context", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/assistants", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "assistants" ], "query": [ { "key": "type", "value": "", "description": "[in: demo, production]", "disabled": true }, { "key": "per_page", "value": "9", "description": "[integer]", "disabled": true } ] }, "description": "List assistants with their v2 build context" } }, { "name": "Everything the builder form needs (base configs, templates, presets, personalities)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/assistants/form-options", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "assistants", "form-options" ] }, "description": "Everything the builder form needs (base configs, templates, presets, personalities)" } }, { "name": "Validate the merged configuration without creating anything", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/assistants/preview", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "assistants", "preview" ] }, "description": "Validate the merged configuration without creating anything", "body": { "mode": "raw", "raw": "{\n \"base_config_id\": 3,\n \"name\": \"Reception\",\n \"type\": \"production\",\n \"layer2_key\": \"friendly-professional\",\n \"prompt_template_id\": 5,\n \"industry_template_id\": 7,\n \"system_prompt\": \"You are Sarah, the AI voice receptionist for Acme Dental.\",\n \"first_message\": \"Thank you for calling {{companyName}}, this is {{personalityName}}. How can I help you today?\",\n \"end_call_message\": \"Thank you for calling {{companyName}}, have a great day!\",\n \"server_url\": \"https://automations.sulus.ai/webhook/lhg-live-demo-agents\",\n \"personality_id\": 12,\n \"metadata\": {\n \"company_name\": \"Acme Dental\",\n \"industry\": \"Dental\"\n },\n \"variable_values\": {\n \"companyName\": \"Acme Dental\",\n \"industry\": \"Dental\",\n \"personalityName\": \"Sarah\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create an assistant from the layered configuration", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/assistants", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "assistants" ] }, "description": "Create an assistant from the layered configuration", "body": { "mode": "raw", "raw": "{\n \"base_config_id\": 3,\n \"name\": \"Reception\",\n \"type\": \"production\",\n \"layer2_key\": \"friendly-professional\",\n \"prompt_template_id\": 5,\n \"industry_template_id\": 7,\n \"system_prompt\": \"You are Sarah, the AI voice receptionist for Acme Dental.\",\n \"first_message\": \"Thank you for calling {{companyName}}, this is {{personalityName}}. How can I help you today?\",\n \"end_call_message\": \"Thank you for calling {{companyName}}, have a great day!\",\n \"server_url\": \"https://automations.sulus.ai/webhook/lhg-live-demo-agents\",\n \"personality_id\": 12,\n \"metadata\": {\n \"company_name\": \"Acme Dental\",\n \"industry\": \"Dental\"\n },\n \"variable_values\": {\n \"companyName\": \"Acme Dental\",\n \"industry\": \"Dental\",\n \"personalityName\": \"Sarah\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve one assistant with live configuration", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/assistants/{{assistantId}}", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "assistants", "{{assistantId}}" ] }, "description": "Retrieve one assistant with live configuration" } }, { "name": "Update through the layered engine", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/assistants/{{assistantId}}", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "assistants", "{{assistantId}}" ] }, "description": "Update through the layered engine", "body": { "mode": "raw", "raw": "{\n \"base_config_id\": 3,\n \"name\": \"Reception\",\n \"type\": \"production\",\n \"layer2_key\": \"concise-efficient\",\n \"first_message\": \"Thank you for calling {{companyName}}, this is {{personalityName}}. How can I help you today?\",\n \"end_call_message\": \"Thank you for calling {{companyName}}, have a great day!\",\n \"server_url\": \"https://automations.sulus.ai/webhook/lhg-live-demo-agents\",\n \"personality_id\": 12,\n \"metadata\": {\n \"company_name\": \"Acme Dental\",\n \"industry\": \"Dental\"\n },\n \"variable_values\": {\n \"companyName\": \"Acme Dental\",\n \"industry\": \"Dental\",\n \"personalityName\": \"Sarah\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an assistant", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v2/assistants/{{assistantId}}", "host": [ "{{base_url}}" ], "path": [ "api", "v2", "assistants", "{{assistantId}}" ] }, "description": "Delete an assistant" } } ] } ] }, { "name": "Squads", "description": "How multi-assistant squads work — the draft-and-publish lifecycle, member and handoff configuration, validation rules, storage columns and limits.", "item": [ { "name": "Squads", "item": [ { "name": "List squads you can access", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squads", "host": [ "{{base_url}}" ], "path": [ "api", "squads" ], "query": [ { "key": "search", "value": "", "description": "[string (name contains-filter)]", "disabled": true }, { "key": "status", "value": "", "description": "[only draft or published are honoured]", "disabled": true }, { "key": "sort_by", "value": "created_at", "description": "[in: name, created_at, updated_at (fallback created_at)]", "disabled": true }, { "key": "sort_order", "value": "desc", "description": "[asc|desc]", "disabled": true }, { "key": "per_page", "value": "15", "description": "[integer]", "disabled": true } ] }, "description": "List squads you can access" } }, { "name": "Create and publish a squad (writes to the live platform first)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squads", "host": [ "{{base_url}}" ], "path": [ "api", "squads" ] }, "description": "Create and publish a squad (writes to the live platform first)", "body": { "mode": "raw", "raw": "{\n \"name\": \"Front desk\",\n \"user_id\": null,\n \"members\": [\n {\n \"assistantId\": \"a1b2c3d4-1e2f-4a3b-8c9d-0e1f2a3b4c5d\",\n \"assistantOverrides\": {\n \"name\": \"Reception\",\n \"description\": \"Front-desk greeter\",\n \"firstMessage\": \"Thanks for calling, how can I help?\",\n \"firstMessageMode\": \"assistant-speaks-first\",\n \"voicemailMessage\": \"Please leave a message after the tone.\",\n \"endCallMessage\": \"Thanks for calling, goodbye!\",\n \"model\": {\"provider\": \"default\", \"model\": \"standard\", \"temperature\": 0.7},\n \"voice\": {\"provider\": \"default\", \"voiceId\": \"voice-standard-1\"},\n \"transcriber\": {\"provider\": \"default\", \"model\": \"standard\", \"language\": \"en\"},\n \"variableValues\": {\"business_name\": \"Acme Dental\"},\n \"metadata\": {\"note\": \"front desk member\"}\n },\n \"assistantDestinations\": [\n {\n \"type\": \"assistant\",\n \"assistantName\": \"Booking\",\n \"message\": \"One moment, transferring you.\",\n \"description\": \"Caller wants to book an appointment\",\n \"transferMode\": \"rolling-history\",\n \"assistantId\": \"b2c3d4e5-2f3a-4b4c-9d0e-1f2a3b4c5d6e\"\n }\n ],\n \"position\": {\"x\": 120.5, \"y\": 240.0}\n },\n {\n \"assistantId\": \"b2c3d4e5-2f3a-4b4c-9d0e-1f2a3b4c5d6e\",\n \"assistantOverrides\": {\"name\": \"Booking\"},\n \"position\": {\"x\": 420.0, \"y\": 240.0}\n }\n ],\n \"membersOverrides\": {\n \"voicemailMessage\": \"Please leave a message after the tone.\",\n \"variableValues\": {\"business_name\": \"Acme Dental\"}\n },\n \"variableValues\": {\"business_name\": \"Acme Dental\", \"business_hours\": \"Mon-Fri 9am-5pm\"},\n \"metadata\": {\"template_id\": 5, \"personality_id\": 16, \"tags\": [\"dental\", \"front-desk\"]}\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve one squad (local state — deliberately no live read)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squads/{{id}}", "host": [ "{{base_url}}" ], "path": [ "api", "squads", "{{id}}" ] }, "description": "Retrieve one squad (local state — deliberately no live read)" } }, { "name": "Publish changes — creates or patches the live squad, sets status published", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squads/{{id}}", "host": [ "{{base_url}}" ], "path": [ "api", "squads", "{{id}}" ] }, "description": "Publish changes — creates or patches the live squad, sets status published", "body": { "mode": "raw", "raw": "{\n \"name\": \"Front desk\",\n \"members\": [\n {\n \"assistantId\": \"a1b2c3d4-1e2f-4a3b-8c9d-0e1f2a3b4c5d\",\n \"assistantOverrides\": {\n \"name\": \"Reception\",\n \"description\": \"Front-desk greeter\",\n \"firstMessage\": \"Thanks for calling, how can I help?\",\n \"firstMessageMode\": \"assistant-speaks-first\",\n \"voicemailMessage\": \"Please leave a message after the tone.\",\n \"endCallMessage\": \"Thanks for calling, goodbye!\",\n \"model\": {\"provider\": \"default\", \"model\": \"standard\", \"temperature\": 0.7},\n \"voice\": {\"provider\": \"default\", \"voiceId\": \"voice-standard-1\"},\n \"transcriber\": {\"provider\": \"default\", \"model\": \"standard\", \"language\": \"en\"},\n \"variableValues\": {\"business_name\": \"Acme Dental\"},\n \"metadata\": {\"note\": \"front desk member\"}\n },\n \"assistantDestinations\": [\n {\n \"type\": \"assistant\",\n \"assistantName\": \"Booking\",\n \"message\": \"One moment, transferring you.\",\n \"description\": \"Caller wants to book an appointment\",\n \"transferMode\": \"rolling-history\",\n \"assistantId\": \"b2c3d4e5-2f3a-4b4c-9d0e-1f2a3b4c5d6e\"\n }\n ],\n \"position\": {\"x\": 120.5, \"y\": 240.0}\n },\n {\n \"assistantId\": \"b2c3d4e5-2f3a-4b4c-9d0e-1f2a3b4c5d6e\",\n \"assistantOverrides\": {\"name\": \"Booking\"},\n \"position\": {\"x\": 420.0, \"y\": 240.0}\n }\n ],\n \"membersOverrides\": {\n \"voicemailMessage\": \"Please leave a message after the tone.\",\n \"variableValues\": {\"business_name\": \"Acme Dental\"}\n },\n \"variableValues\": {\"business_name\": \"Acme Dental\", \"business_hours\": \"Mon-Fri 9am-5pm\"},\n \"metadata\": {\"template_id\": 5, \"personality_id\": 16, \"tags\": [\"dental\", \"front-desk\"]}\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a squad (live first for published; drafts are local-only)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squads/{{id}}", "host": [ "{{base_url}}" ], "path": [ "api", "squads", "{{id}}" ] }, "description": "Delete a squad (live first for published; drafts are local-only)" } }, { "name": "Duplicate as a local draft copy", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squads/{{id}}/duplicate", "host": [ "{{base_url}}" ], "path": [ "api", "squads", "{{id}}", "duplicate" ] }, "description": "Duplicate as a local draft copy" } } ] }, { "name": "Drafts", "item": [ { "name": "Save a local draft (never touches live routing)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squads/draft", "host": [ "{{base_url}}" ], "path": [ "api", "squads", "draft" ] }, "description": "Save a local draft (never touches live routing)", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"members\": [\n {\n \"assistantId\": \"a1b2c3d4-1e2f-4a3b-8c9d-0e1f2a3b4c5d\",\n \"assistantOverrides\": {\"name\": \"Reception\", \"firstMessage\": \"Thanks for calling, how can I help?\"},\n \"assistantDestinations\": [],\n \"position\": {\"x\": 120.5, \"y\": 240.0}\n }\n ],\n \"membersOverrides\": {\"voicemailMessage\": \"Please leave a message after the tone.\"},\n \"variableValues\": {\"business_name\": \"Acme Dental\"},\n \"metadata\": {\"template_id\": 5, \"personality_id\": 16}\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update a draft — or demote a published squad to draft locally", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squads/{{id}}/draft", "host": [ "{{base_url}}" ], "path": [ "api", "squads", "{{id}}", "draft" ] }, "description": "Update a draft — or demote a published squad to draft locally", "body": { "mode": "raw", "raw": "{\n \"name\": \"Front desk\",\n \"members\": [\n {\n \"assistantId\": \"a1b2c3d4-1e2f-4a3b-8c9d-0e1f2a3b4c5d\",\n \"assistantOverrides\": {\"name\": \"Reception\", \"firstMessage\": \"Thanks for calling, how can I help?\"},\n \"assistantDestinations\": [\n {\"type\": \"assistant\", \"assistantName\": \"Booking\", \"message\": \"One moment, transferring you.\", \"description\": \"Caller wants to book an appointment\", \"transferMode\": \"rolling-history\"}\n ],\n \"position\": {\"x\": 120.5, \"y\": 240.0}\n },\n {\n \"assistantId\": \"b2c3d4e5-2f3a-4b4c-9d0e-1f2a3b4c5d6e\",\n \"assistantOverrides\": {\"name\": \"Booking\"},\n \"position\": {\"x\": 420.0, \"y\": 240.0}\n }\n ],\n \"membersOverrides\": {\"voicemailMessage\": \"Please leave a message after the tone.\"},\n \"variableValues\": {\"business_name\": \"Acme Dental\"},\n \"metadata\": {\"template_id\": 5, \"personality_id\": 16}\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Tools", "description": "How custom tools work — the draft-and-publish lifecycle, request/function/transfer configuration, personal credentials, assistant assignment, validation rules, and storage columns.", "item": [ { "name": "Tools", "item": [ { "name": "List tools you can access", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools", "host": [ "{{base_url}}" ], "path": [ "api", "tools" ], "query": [ { "key": "search", "value": "", "description": "[string (name contains-filter)]", "disabled": true }, { "key": "status", "value": "", "description": "[only draft or published are honoured]", "disabled": true }, { "key": "type", "value": "", "description": "[in: apiRequest, function, transferCall, endCall, dtmf, voicemail, handoff, query, mcp]", "disabled": true }, { "key": "scope", "value": "", "description": "[global (user_id is null) or account (user_id is not null)]", "disabled": true }, { "key": "sort_by", "value": "created_at", "description": "[in: name, created_at, updated_at (fallback created_at)]", "disabled": true }, { "key": "sort_order", "value": "desc", "description": "[asc|desc]", "disabled": true }, { "key": "per_page", "value": "15", "description": "[integer]", "disabled": true } ] }, "description": "List tools you can access" } }, { "name": "Create and publish a tool (writes to the live platform first)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools", "host": [ "{{base_url}}" ], "path": [ "api", "tools" ] }, "description": "Create and publish a tool (writes to the live platform first)", "body": { "mode": "raw", "raw": "{\n \"name\": \"Check Order Status\",\n \"type\": \"apiRequest\",\n \"description\": \"Looks up an order by ID and returns its current status.\",\n \"server\": {\n \"url\": \"https://api.example-business.com/orders/lookup\",\n \"method\": \"POST\",\n \"timeoutSeconds\": 20,\n \"headers\": [{\"key\": \"X-Api-Key\", \"value\": \"{{env.ORDERS_API_KEY}}\"}],\n \"bodyProperties\": [\n {\"name\": \"orderId\", \"type\": \"string\", \"description\": \"The order confirmation number\", \"required\": true}\n ],\n \"staticFields\": [{\"key\": \"source\", \"type\": \"string\", \"value\": \"voice-assistant\"}],\n \"lockSchema\": false,\n \"encryptedFields\": [\"X-Api-Key\"],\n \"backoffPlan\": {\"type\": \"exponential\", \"maxRetries\": 3, \"baseDelaySeconds\": 2, \"excludedStatusCodes\": [400, 404]},\n \"credentialId\": \"3f9c2a10-6b4e-4a2d-9f0a-1c2d3e4f5a6b\"\n },\n \"variableExtractionPlan\": {\n \"properties\": [\n {\"name\": \"orderStatus\", \"type\": \"string\", \"description\": \"Current status of the order\", \"required\": false}\n ],\n \"aliases\": [{\"key\": \"status\", \"value\": \"orderStatus\"}]\n },\n \"rejectionPlan\": {\n \"conditions\": [{\"type\": \"regex\", \"value\": \"^(cancelled|refunded)$\"}]\n },\n \"messages\": [\n {\"type\": \"request-start\", \"mode\": \"custom\", \"content\": \"Let me check on that order for you.\"},\n {\"type\": \"request-failed\", \"mode\": \"custom\", \"content\": \"I'm having trouble reaching our order system right now.\"}\n ],\n \"async\": false,\n \"metadata\": {\"category\": \"orders\"}\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve one tool", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/{{id}}", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "{{id}}" ] }, "description": "Retrieve one tool" } }, { "name": "Publish changes — creates or patches the live tool, sets status published", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/{{id}}", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "{{id}}" ] }, "description": "Publish changes — creates or patches the live tool, sets status published", "body": { "mode": "raw", "raw": "{\n \"name\": \"Check Order Status\",\n \"type\": \"apiRequest\",\n \"description\": \"Looks up an order by ID and returns its current status, including estimated delivery date.\",\n \"server\": {\n \"url\": \"https://api.example-business.com/orders/lookup\",\n \"method\": \"POST\",\n \"timeoutSeconds\": 25,\n \"headers\": [{\"key\": \"X-Api-Key\", \"value\": \"{{env.ORDERS_API_KEY}}\"}],\n \"bodyProperties\": [\n {\"name\": \"orderId\", \"type\": \"string\", \"description\": \"The order confirmation number\", \"required\": true}\n ],\n \"credentialId\": \"3f9c2a10-6b4e-4a2d-9f0a-1c2d3e4f5a6b\"\n },\n \"variableExtractionPlan\": {\n \"properties\": [\n {\"name\": \"orderStatus\", \"type\": \"string\", \"description\": \"Current status of the order\", \"required\": false},\n {\"name\": \"estimatedDelivery\", \"type\": \"string\", \"description\": \"Estimated delivery date\", \"required\": false}\n ]\n },\n \"messages\": [\n {\"type\": \"request-start\", \"mode\": \"custom\", \"content\": \"Let me check on that order for you.\"}\n ],\n \"async\": false,\n \"metadata\": {\"category\": \"orders\"}\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a tool (live first for published; drafts are local-only)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/{{id}}", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "{{id}}" ] }, "description": "Delete a tool (live first for published; drafts are local-only)" } }, { "name": "Duplicate as a local draft copy", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/{{id}}/duplicate", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "{{id}}", "duplicate" ] }, "description": "Duplicate as a local draft copy" } } ] }, { "name": "Drafts", "item": [ { "name": "Save a local draft (never touches the live platform)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/draft", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "draft" ] }, "description": "Save a local draft (never touches the live platform)", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"function\",\n \"description\": \"Looks up loyalty points for a phone number.\",\n \"parameters\": [\n {\"name\": \"phoneNumber\", \"type\": \"string\", \"description\": \"Caller's phone number\", \"required\": true}\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update a draft — or demote a published tool to draft locally", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/{{id}}/draft", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "{{id}}", "draft" ] }, "description": "Update a draft — or demote a published tool to draft locally", "body": { "mode": "raw", "raw": "{\n \"name\": \"Loyalty Points Lookup\",\n \"type\": \"function\",\n \"description\": \"Looks up loyalty points for a phone number.\",\n \"parameters\": [\n {\"name\": \"phoneNumber\", \"type\": \"string\", \"description\": \"Caller's phone number\", \"required\": true}\n ],\n \"strict\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Publish a stored tool — reconstructs the builder model from the database and pushes it live", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/{{id}}/publish", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "{{id}}", "publish" ] }, "description": "Publish a stored tool — reconstructs the builder model from the database and pushes it live" } } ] }, { "name": "Assignments", "item": [ { "name": "List the caller's assistants with an attached flag for this tool", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/{{id}}/assistants", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "{{id}}", "assistants" ] }, "description": "List the caller's assistants with an attached flag for this tool" } }, { "name": "Bulk attach/detach this tool across the caller's assistants", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/{{id}}/assistants", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "{{id}}", "assistants" ] }, "description": "Bulk attach/detach this tool across the caller's assistants", "body": { "mode": "raw", "raw": "{\n \"assistant_ids\": [\"a1b2c3d4-1e2f-4a3b-8c9d-0e1f2a3b4c5d\"]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Credentials", "item": [ { "name": "Slim list of the caller's active credentials, for the Authorization dropdown", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/credentials", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "credentials" ] }, "description": "Slim list of the caller's active credentials, for the Authorization dropdown" } }, { "name": "Full list of the caller's personal credentials, for the credential manager", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/credentials/manage", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "credentials", "manage" ] }, "description": "Full list of the caller's personal credentials, for the credential manager" } }, { "name": "Create a personal server-auth credential", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/credentials", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "credentials" ] }, "description": "Create a personal server-auth credential", "body": { "mode": "raw", "raw": "{\n \"provider\": \"custom-credential\",\n \"name\": \"Orders API\",\n \"authenticationPlan\": {\n \"type\": \"bearer\",\n \"token\": \"sk_live_51Hxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"bearerPrefixEnabled\": true\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update an owned credential (auth type is immutable)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/credentials/{{id}}", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "credentials", "{{id}}" ] }, "description": "Update an owned credential (auth type is immutable)", "body": { "mode": "raw", "raw": "{\n \"provider\": \"custom-credential\",\n \"name\": \"Orders API (v2)\",\n \"authenticationPlan\": {\n \"type\": \"bearer\",\n \"token\": \"sk_live_51Hyyyyyyyyyyyyyyyyyyyyyyyy\",\n \"bearerPrefixEnabled\": true\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Toggle a credential active/inactive", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/credentials/{{id}}/status", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "credentials", "{{id}}", "status" ] }, "description": "Toggle a credential active/inactive", "body": { "mode": "raw", "raw": "{\n \"status\": \"inactive\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an owned credential (live platform, then locally)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/tools/credentials/{{id}}", "host": [ "{{base_url}}" ], "path": [ "api", "tools", "credentials", "{{id}}" ] }, "description": "Delete an owned credential (live platform, then locally)" } } ] } ] }, { "name": "Phone Numbers", "description": "Search inventory, purchase unassigned numbers, then configure inbound routing, fallback destination, webhook server, hooks, and SMS.", "item": [ { "name": "Phone Numbers", "item": [ { "name": "Search purchasable phone number inventory", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/phone-numbers/available", "host": [ "{{base_url}}" ], "path": [ "api", "phone-numbers", "available" ], "query": [ { "key": "country", "value": "", "description": "Country name; mapped to a 2-letter country_code when provided. [nullable|string|in:United States,Canada,Australia,United Kingdom]", "disabled": true }, { "key": "country_code", "value": "US", "description": "ISO country code used when country is omitted. [nullable|string|max:2]", "disabled": true }, { "key": "area_code", "value": "", "description": "[nullable|string|max:3 (exactly 3 digits when set; only US, CA, AU, GB)]", "disabled": true }, { "key": "limit", "value": "10", "description": "[nullable|integer|min:1|max:50]", "disabled": true } ] }, "description": "Search purchasable phone number inventory" } }, { "name": "Purchase a phone number and register it unassigned", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/phone-numbers", "host": [ "{{base_url}}" ], "path": [ "api", "phone-numbers" ] }, "description": "Purchase a phone number and register it unassigned", "body": { "mode": "raw", "raw": "{\n \"phone_number\": \"+14155551234\",\n \"country_code\": \"US\",\n \"name\": \"Main Line\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List phone numbers you can access", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/phone-numbers", "host": [ "{{base_url}}" ], "path": [ "api", "phone-numbers" ], "query": [ { "key": "search", "value": "", "description": "[string (matches phone_number or name)]", "disabled": true }, { "key": "page", "value": "1", "description": "[clamped to a minimum of 1]", "disabled": true }, { "key": "per_page", "value": "15", "description": "[clamped between 1 and 100]", "disabled": true } ] }, "description": "List phone numbers you can access" } }, { "name": "Open a number for editing (materialises its configuration on first touch)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/phone-numbers/{{id}}", "host": [ "{{base_url}}" ], "path": [ "api", "phone-numbers", "{{id}}" ] }, "description": "Open a number for editing (materialises its configuration on first touch)" } }, { "name": "Update a number's configuration (writes to the live voice platform first, then mirrors locally)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/phone-numbers/{{id}}", "host": [ "{{base_url}}" ], "path": [ "api", "phone-numbers", "{{id}}" ] }, "description": "Update a number's configuration (writes to the live voice platform first, then mirrors locally)", "body": { "mode": "raw", "raw": "{\n \"name\": \"Front Desk Line\",\n \"vapi_assistant_id\": \"a1b2c3d4-1e2f-4a3b-8c9d-0e1f2a3b4c5d\",\n \"sms_enabled\": true,\n \"static_ip_enabled\": false,\n \"fallback_destination\": {\n \"type\": \"number\",\n \"number\": \"+14155559876\",\n \"message\": \"Please hold while we connect you.\",\n \"description\": \"Used when the assistant is unavailable\",\n \"callerId\": \"+14155551234\"\n },\n \"server\": {\n \"url\": \"https://api.example-business.com/webhooks/calls\",\n \"secret\": \"whsec_5f4dcc3b5aa765d61d8327deb882cf99\",\n \"timeoutSeconds\": 20,\n \"headers\": {\"X-Source\": \"sulus\"}\n },\n \"hooks\": []\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Knowledge Docs", "description": "Document libraries, publishing and search sync, assistant assignment, and per-user sharing by email.", "item": [ { "name": "Libraries", "item": [ { "name": "List libraries you can access (auto-provisions your default library)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases" ], "query": [ { "key": "search", "value": "", "description": "[string (matches name, description, or the owner's name/email)]", "disabled": true }, { "key": "owner_user_id", "value": "", "description": "[honoured only for super admins and reseller admins]", "disabled": true }, { "key": "status", "value": "", "description": "[in: published, draft, archived — filters to libraries containing at least one document in that status]", "disabled": true }, { "key": "sort_by", "value": "name", "description": "[in: name, created_at, updated_at, articles_count (falls back to name)]", "disabled": true }, { "key": "sort_dir", "value": "asc", "description": "[anything other than desc (case-insensitive) is treated as asc]", "disabled": true } ] }, "description": "List libraries you can access (auto-provisions your default library)" } }, { "name": "Create a library", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases" ] }, "description": "Create a library", "body": { "mode": "raw", "raw": "{\n \"name\": \"Product FAQs\",\n \"description\": \"Customer-facing answers for the support line.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a library and every document in it", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/{{knowledge_base}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "{{knowledge_base}}" ] }, "description": "Delete a library and every document in it" } }, { "name": "Resolve or provision a usable library for an assistant, without visiting Knowledge Docs first", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/ensure-default", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "ensure-default" ] }, "description": "Resolve or provision a usable library for an assistant, without visiting Knowledge Docs first", "body": { "mode": "raw", "raw": "{\n \"assistant_id\": 12\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Documents", "item": [ { "name": "List documents in a library (summary projection)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/{{knowledge_base}}/articles", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "{{knowledge_base}}", "articles" ] }, "description": "List documents in a library (summary projection)" } }, { "name": "Create a document in a library", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/{{knowledge_base}}/articles", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "{{knowledge_base}}", "articles" ] }, "description": "Create a document in a library", "body": { "mode": "raw", "raw": "{\n \"title\": \"Return Policy\",\n \"content\": \"

Returns

Items can be returned within 30 days of purchase with a receipt.

\",\n \"status\": \"published\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve one document (full content)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/{{knowledge_base}}/articles/{{article}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "{{knowledge_base}}", "articles", "{{article}}" ] }, "description": "Retrieve one document (full content)" } }, { "name": "Update a document", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/{{knowledge_base}}/articles/{{article}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "{{knowledge_base}}", "articles", "{{article}}" ] }, "description": "Update a document", "body": { "mode": "raw", "raw": "{\n \"content\": \"

Returns

Items can be returned within 60 days of purchase with a receipt.

\",\n \"status\": \"published\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a document", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/{{knowledge_base}}/articles/{{article}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "{{knowledge_base}}", "articles", "{{article}}" ] }, "description": "Delete a document" } }, { "name": "Force an immediate re-sync of a published document to search", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/{{knowledge_base}}/articles/{{article}}/sync", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "{{knowledge_base}}", "articles", "{{article}}", "sync" ] }, "description": "Force an immediate re-sync of a published document to search" } } ] }, { "name": "Assignments", "item": [ { "name": "Assign one or more published documents to one or more assistants", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/article-assign", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "article-assign" ] }, "description": "Assign one or more published documents to one or more assistants", "body": { "mode": "raw", "raw": "{\n \"knowledge_article_ids\": [\"b2c3d4e5-f6a7-8901-bcde-f23456789012\"],\n \"assistant_ids\": [12]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove one assignment", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/article-assign/{{id}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "article-assign", "{{id}}" ] }, "description": "Remove one assignment" } }, { "name": "List every assignment for documents in a library, across all assistants", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/{{knowledge_base}}/assignments", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "{{knowledge_base}}", "assignments" ] }, "description": "List every assignment for documents in a library, across all assistants" } }, { "name": "List documents linked to an assistant (for the assistant editor)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/assistant/{{assistantId}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "assistant", "{{assistantId}}" ] }, "description": "List documents linked to an assistant (for the assistant editor)" } }, { "name": "Search published documents the caller could still attach to an assistant", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/assistant/{{assistantId}}/assignable-articles", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "assistant", "{{assistantId}}", "assignable-articles" ], "query": [ { "key": "q", "value": "", "description": "Title contains-filter. [nullable|string|max:200]", "disabled": true } ] }, "description": "Search published documents the caller could still attach to an assistant" } } ] }, { "name": "Sharing", "item": [ { "name": "Get who a document is shared with, and who has a pending invite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/{{knowledge_base}}/articles/{{article}}/share", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "{{knowledge_base}}", "articles", "{{article}}", "share" ] }, "description": "Get who a document is shared with, and who has a pending invite" } }, { "name": "Share a document with one email address", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/{{knowledge_base}}/articles/{{article}}/share/invite", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "{{knowledge_base}}", "articles", "{{article}}", "share", "invite" ] }, "description": "Share a document with one email address", "body": { "mode": "raw", "raw": "{\n \"email\": \"john@example.com\",\n \"can_view\": true,\n \"can_edit\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change a recipient's Read/Write permission", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/{{knowledge_base}}/articles/{{article}}/share/permission", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "{{knowledge_base}}", "articles", "{{article}}", "share", "permission" ] }, "description": "Change a recipient's Read/Write permission", "body": { "mode": "raw", "raw": "{\n \"email\": \"john@example.com\",\n \"can_view\": true,\n \"can_edit\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove one recipient's access", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/knowledge-bases/{{knowledge_base}}/articles/{{article}}/share/remove", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "knowledge-bases", "{{knowledge_base}}", "articles", "{{article}}", "share", "remove" ] }, "description": "Remove one recipient's access", "body": { "mode": "raw", "raw": "{\n \"email\": \"john@example.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List documents other people have shared with the current user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/shared-with-me", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "shared-with-me" ] }, "description": "List documents other people have shared with the current user" } }, { "name": "Open a document shared with the current user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/shared-with-me/{{article}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "shared-with-me", "{{article}}" ] }, "description": "Open a document shared with the current user" } }, { "name": "Edit a document shared with the current user (title/content only)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/kb/shared-with-me/{{article}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "kb", "shared-with-me", "{{article}}" ] }, "description": "Edit a document shared with the current user (title/content only)", "body": { "mode": "raw", "raw": "{\n \"content\": \"

Returns

Items can be returned within 45 days of purchase with a receipt.

\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Agents", "description": "How the agent system works — the endpoints, fields, validation rules, storage columns and limits behind agents, chats, messages, knowledge files and connector tools.", "item": [ { "name": "Chat completions", "item": [ { "name": "Send a chat-completions request to an agent", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/chat/completions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "chat", "completions" ] }, "description": "Send a chat-completions request to an agent", "body": { "mode": "raw", "raw": "{\n \"model\": \"sulus-chat-1\",\n \"messages\": [\n {\"role\": \"system\", \"content\": \"You are speaking with a returning customer.\"},\n {\"role\": \"user\", \"content\": \"What are your opening hours?\"}\n ],\n \"agent\": \"a1b2c3d4-0000-4000-8000-000000000001\",\n \"chat\": \"b2c3d4e5-0000-4000-8000-000000000002\",\n \"stream\": false\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Models & usage", "item": [ { "name": "List available model ids", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/models", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "models" ] }, "description": "List available model ids" } }, { "name": "Prepaid-USD balance and account counts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/usage", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "usage" ] }, "description": "Prepaid-USD balance and account counts" } } ] }, { "name": "Agents", "item": [ { "name": "List agents you can access", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents" ], "query": [ { "key": "per_page", "value": "50", "description": "Items per page. [integer, clamped 1–100]", "disabled": true }, { "key": "q", "value": "", "description": "Search filter. [string (name/description contains-filter)]", "disabled": true }, { "key": "sort", "value": "updated", "description": "Sort order. [in: updated, name]", "disabled": true } ] }, "description": "List agents you can access" } }, { "name": "Create an agent", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents" ] }, "description": "Create an agent", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Agent\",\n \"description\": \"Answers customer support questions.\",\n \"instructions\": \"Be concise and friendly.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve one agent", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}" ] }, "description": "Retrieve one agent" } }, { "name": "Update an agent (PUT also accepted)", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}" ] }, "description": "Update an agent (PUT also accepted)", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Agent\",\n \"description\": \"Handles pre-sales questions too.\",\n \"instructions\": \"Be concise, friendly, and offer to connect the caller with a specialist for pricing.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an agent and everything in it", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}" ] }, "description": "Delete an agent and everything in it" } } ] }, { "name": "Conversations", "item": [ { "name": "List your chats in an agent", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/chats", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "chats" ] }, "description": "List your chats in an agent" } }, { "name": "Start a new chat thread", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/chats", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "chats" ] }, "description": "Start a new chat thread", "body": { "mode": "raw", "raw": "{\n \"model\": \"sulus-chat-1\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve one chat", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/chats/{{chat_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "chats", "{{chat_id}}" ] }, "description": "Retrieve one chat" } }, { "name": "Rename a chat (PUT also accepted)", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/chats/{{chat_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "chats", "{{chat_id}}" ] }, "description": "Rename a chat (PUT also accepted)", "body": { "mode": "raw", "raw": "{\"title\": \"Pricing questions\"}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a chat and its messages", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/chats/{{chat_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "chats", "{{chat_id}}" ] }, "description": "Delete a chat and its messages" } } ] }, { "name": "Messages", "item": [ { "name": "List messages (oldest first)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/chats/{{chat_id}}/messages", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "chats", "{{chat_id}}", "messages" ], "query": [ { "key": "per_page", "value": "30", "description": "Messages per page. [integer, clamped 1–100]", "disabled": true }, { "key": "before_id", "value": "", "description": "Cursor for older pages: pass the id of the first message from the previous response. [integer — fetch messages with id < before_id]", "disabled": true } ] }, "description": "List messages (oldest first)" } }, { "name": "Send a message and get the assistant reply", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/chats/{{chat_id}}/messages", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "chats", "{{chat_id}}", "messages" ] }, "description": "Send a message and get the assistant reply", "body": { "mode": "raw", "raw": "{\n \"content\": \"Summarise our refund policy.\",\n \"model\": \"sulus-chat-1\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Knowledge files", "item": [ { "name": "List an agent's knowledge files", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/files", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "files" ] }, "description": "List an agent's knowledge files" } }, { "name": "Upload a knowledge file (multipart)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/files", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "files" ] }, "description": "Upload a knowledge file (multipart)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [] } ] } } }, { "name": "Delete a knowledge file", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/files/{{file_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "files", "{{file_id}}" ] }, "description": "Delete a knowledge file" } } ] }, { "name": "Connectors", "item": [ { "name": "List connectors available to an agent", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/connectors", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "connectors" ] }, "description": "List connectors available to an agent" } }, { "name": "Enable or disable a connector for this agent", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/connectors/{{connector_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "connectors", "{{connector_id}}" ] }, "description": "Enable or disable a connector for this agent", "body": { "mode": "raw", "raw": "{\"enabled\": true}", "options": { "raw": { "language": "json" } } } } }, { "name": "Switch one tool of an enabled connector on or off", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/connectors/{{connector_id}}/tools", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "connectors", "{{connector_id}}", "tools" ] }, "description": "Switch one tool of an enabled connector on or off", "body": { "mode": "raw", "raw": "{\"tool\": \"search-docs\", \"enabled\": false}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set per-agent description, purpose, and use case for an enabled connector", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/v1/agents/{{agent_id}}/connectors/{{connector_id}}/context", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "agents", "{{agent_id}}", "connectors", "{{connector_id}}", "context" ] }, "description": "Set per-agent description, purpose, and use case for an enabled connector", "body": { "mode": "raw", "raw": "{\n \"description\": \"Use this connector only for this agent's customer lookups.\",\n \"purpose\": \"Look up the caller in the customer directory before quoting hours.\",\n \"use_case\": \"When the caller asks about their account or a recent order.\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Call History", "description": "List, search, summarise, and open individual assistant call logs — recordings, transcripts, and structured conversations.", "item": [ { "name": "Call History", "item": [ { "name": "List call logs (dashboard default)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/call-logs/list", "host": [ "{{base_url}}" ], "path": [ "api", "call-logs", "list" ], "query": [ { "key": "assistant_id", "value": "", "description": "Limit results to one local assistant id.", "disabled": true }, { "key": "status", "value": "", "description": "When present, filters call_logs.status exactly (the dashboard clears \"all\" client-side before calling).", "disabled": true }, { "key": "direction", "value": "", "description": "When present, filters call_logs.direction exactly (the dashboard clears \"all\" client-side before calling).", "disabled": true }, { "key": "start_date", "value": "", "description": "Inclusive lower bound on start_time (date portion).", "disabled": true }, { "key": "end_date", "value": "", "description": "Inclusive upper bound on start_time (date portion).", "disabled": true }, { "key": "search", "value": "", "description": "Substring match on call_id and summary (list/index). On /search it is required and also matches transcript.", "disabled": true }, { "key": "per_page", "value": "20", "description": "Page size. Not clamped in this controller.", "disabled": true }, { "key": "page", "value": "1", "description": "Laravel paginator page number.", "disabled": true } ] }, "description": "List call logs (dashboard default)" } }, { "name": "Full-text search call logs (call id, summary, transcript)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/call-logs/search", "host": [ "{{base_url}}" ], "path": [ "api", "call-logs", "search" ], "query": [ { "key": "search", "value": "", "description": "Search term. Matched with LIKE against call_id, summary, and transcript. [required; minimum length 3 (enforced in controller, not FormRequest)]", "disabled": true }, { "key": "assistant_id", "value": "", "description": "Limit results to one local assistant id.", "disabled": true }, { "key": "status", "value": "", "description": "When present and not the literal string \"all\", filters call_logs.status.", "disabled": true }, { "key": "direction", "value": "", "description": "When present and not the literal string \"all\", filters call_logs.direction.", "disabled": true }, { "key": "start_date", "value": "", "description": "Inclusive lower bound on start_time (date portion).", "disabled": true }, { "key": "end_date", "value": "", "description": "Inclusive upper bound on start_time (date portion).", "disabled": true }, { "key": "per_page", "value": "15", "description": "Page size. Not clamped in this controller.", "disabled": true }, { "key": "page", "value": "1", "description": "Laravel paginator page number.", "disabled": true } ] }, "description": "Full-text search call logs (call id, summary, transcript)" } }, { "name": "List call logs (legacy index; includes created_at)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/call-logs", "host": [ "{{base_url}}" ], "path": [ "api", "call-logs" ], "query": [ { "key": "assistant_id", "value": "", "description": "Limit results to one local assistant id.", "disabled": true }, { "key": "status", "value": "", "description": "When present and not the literal string \"all\", filters call_logs.status.", "disabled": true }, { "key": "direction", "value": "", "description": "When present and not the literal string \"all\", filters call_logs.direction.", "disabled": true }, { "key": "start_date", "value": "", "description": "Inclusive lower bound on start_time (date portion).", "disabled": true }, { "key": "end_date", "value": "", "description": "Inclusive upper bound on start_time (date portion).", "disabled": true }, { "key": "search", "value": "", "description": "Substring match on call_id and summary (list/index). On /search it is required and also matches transcript.", "disabled": true }, { "key": "per_page", "value": "20", "description": "Page size. Not clamped in this controller.", "disabled": true }, { "key": "page", "value": "1", "description": "Laravel paginator page number.", "disabled": true } ] }, "description": "List call logs (legacy index; includes created_at)" } }, { "name": "Aggregate call statistics for the scoped account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/call-logs/stats", "host": [ "{{base_url}}" ], "path": [ "api", "call-logs", "stats" ], "query": [ { "key": "start_date", "value": "", "description": "Inclusive lower bound on start_time (date portion).", "disabled": true }, { "key": "end_date", "value": "", "description": "Inclusive upper bound on start_time (date portion).", "disabled": true }, { "key": "assistant_id", "value": "", "description": "Limit aggregates to one local assistant id.", "disabled": true } ] }, "description": "Aggregate call statistics for the scoped account" } }, { "name": "Retrieve one call log and its structured conversation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/call-logs/{{callId}}", "host": [ "{{base_url}}" ], "path": [ "api", "call-logs", "{{callId}}" ] }, "description": "Retrieve one call log and its structured conversation" } } ] } ] }, { "name": "Squad Call History", "description": "List, search, summarise, and open individual squad call logs — recordings, transcripts, and structured conversations.", "item": [ { "name": "Squad Call History", "item": [ { "name": "List squad call logs (dashboard default; alias of index)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squad-call-logs/list", "host": [ "{{base_url}}" ], "path": [ "api", "squad-call-logs", "list" ], "query": [ { "key": "squad_id", "value": "", "description": "Filter by local squads.id. Accepted as a query filter only — the numeric squad_id is stripped from every response row.", "disabled": true }, { "key": "assistant_id", "value": "", "description": "Filter by the member assistant that was active at end of call (local assistants.id).", "disabled": true }, { "key": "status", "value": "", "description": "When present and not the literal string \"all\", filters status.", "disabled": true }, { "key": "direction", "value": "", "description": "When present and not the literal string \"all\", filters direction.", "disabled": true }, { "key": "start_date", "value": "", "description": "Inclusive lower bound on start_time (date portion).", "disabled": true }, { "key": "end_date", "value": "", "description": "Inclusive upper bound on start_time (date portion).", "disabled": true }, { "key": "search", "value": "", "description": "Substring match on call_id and summary (list/index). On /search it is required and also matches transcript.", "disabled": true }, { "key": "per_page", "value": "20", "description": "Page size. Not clamped in this controller.", "disabled": true }, { "key": "page", "value": "1", "description": "Laravel paginator page number.", "disabled": true } ] }, "description": "List squad call logs (dashboard default; alias of index)" } }, { "name": "Full-text search squad call logs (call id, summary, transcript)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squad-call-logs/search", "host": [ "{{base_url}}" ], "path": [ "api", "squad-call-logs", "search" ], "query": [ { "key": "search", "value": "", "description": "Search term. Matched with LIKE against call_id, summary, and transcript. [required; minimum length 3 (enforced in controller, not FormRequest)]", "disabled": true }, { "key": "squad_id", "value": "", "description": "Filter by local squads.id. Accepted as a query filter only — the numeric squad_id is stripped from every response row.", "disabled": true }, { "key": "assistant_id", "value": "", "description": "Filter by the member assistant that was active at end of call (local assistants.id).", "disabled": true }, { "key": "status", "value": "", "description": "When present and not the literal string \"all\", filters status.", "disabled": true }, { "key": "direction", "value": "", "description": "When present and not the literal string \"all\", filters direction.", "disabled": true }, { "key": "start_date", "value": "", "description": "Inclusive lower bound on start_time (date portion).", "disabled": true }, { "key": "end_date", "value": "", "description": "Inclusive upper bound on start_time (date portion).", "disabled": true }, { "key": "per_page", "value": "15", "description": "Page size. Not clamped in this controller.", "disabled": true }, { "key": "page", "value": "1", "description": "Laravel paginator page number.", "disabled": true } ] }, "description": "Full-text search squad call logs (call id, summary, transcript)" } }, { "name": "List squad call logs (same implementation as /list)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squad-call-logs", "host": [ "{{base_url}}" ], "path": [ "api", "squad-call-logs" ], "query": [ { "key": "squad_id", "value": "", "description": "Filter by local squads.id. Accepted as a query filter only — the numeric squad_id is stripped from every response row.", "disabled": true }, { "key": "assistant_id", "value": "", "description": "Filter by the member assistant that was active at end of call (local assistants.id).", "disabled": true }, { "key": "status", "value": "", "description": "When present and not the literal string \"all\", filters status.", "disabled": true }, { "key": "direction", "value": "", "description": "When present and not the literal string \"all\", filters direction.", "disabled": true }, { "key": "start_date", "value": "", "description": "Inclusive lower bound on start_time (date portion).", "disabled": true }, { "key": "end_date", "value": "", "description": "Inclusive upper bound on start_time (date portion).", "disabled": true }, { "key": "search", "value": "", "description": "Substring match on call_id and summary (list/index). On /search it is required and also matches transcript.", "disabled": true }, { "key": "per_page", "value": "20", "description": "Page size. Not clamped in this controller.", "disabled": true }, { "key": "page", "value": "1", "description": "Laravel paginator page number.", "disabled": true } ] }, "description": "List squad call logs (same implementation as /list)" } }, { "name": "Aggregate squad call statistics for the scoped account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squad-call-logs/stats", "host": [ "{{base_url}}" ], "path": [ "api", "squad-call-logs", "stats" ], "query": [ { "key": "start_date", "value": "", "description": "Inclusive lower bound on start_time (date portion).", "disabled": true }, { "key": "end_date", "value": "", "description": "Inclusive upper bound on start_time (date portion).", "disabled": true }, { "key": "squad_id", "value": "", "description": "Limit aggregates to one local squad id.", "disabled": true }, { "key": "assistant_id", "value": "", "description": "Limit aggregates to one member assistant id.", "disabled": true } ] }, "description": "Aggregate squad call statistics for the scoped account" } }, { "name": "Retrieve one squad call log and its structured conversation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/squad-call-logs/{{callId}}", "host": [ "{{base_url}}" ], "path": [ "api", "squad-call-logs", "{{callId}}" ] }, "description": "Retrieve one squad call log and its structured conversation" } } ] } ] }, { "name": "Analytics", "description": "End-user dashboard analytics — overview totals, recent calls, call trends, top assistants, active subscriptions, and the activity feed.", "item": [ { "name": "Analytics", "item": [ { "name": "Get the Analytics dashboard overview bundle", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/dashboard/stats", "host": [ "{{base_url}}" ], "path": [ "api", "dashboard", "stats" ] }, "description": "Get the Analytics dashboard overview bundle" } }, { "name": "Get a merged recent-activity feed", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/dashboard/activity", "host": [ "{{base_url}}" ], "path": [ "api", "dashboard", "activity" ] }, "description": "Get a merged recent-activity feed" } } ] } ] }, { "name": "Connect GoHighLevel", "description": "Connect one or more GoHighLevel locations to your account — OAuth install URL, manual token link, list/update/remove connections, and choose a default.", "item": [ { "name": "Connect GoHighLevel", "item": [ { "name": "Get compact connection status for the current user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner-end-user/status", "host": [ "{{base_url}}" ], "path": [ "api", "partner-end-user", "status" ] }, "description": "Get compact connection status for the current user" } }, { "name": "Build the GoHighLevel OAuth / marketplace installation URL", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner-end-user/oauth/authorize-url", "host": [ "{{base_url}}" ], "path": [ "api", "partner-end-user", "oauth", "authorize-url" ], "query": [ { "key": "return_to", "value": "/", "description": "Path to return to after install (stored in encrypted OAuth state).", "disabled": true }, { "key": "return_origin", "value": "", "description": "Origin override; otherwise derived from the reseller / request host.", "disabled": true } ] }, "description": "Build the GoHighLevel OAuth / marketplace installation URL" } }, { "name": "Manually link a location with an access token (legacy helper)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner-end-user/manual-connect", "host": [ "{{base_url}}" ], "path": [ "api", "partner-end-user", "manual-connect" ] }, "description": "Manually link a location with an access token (legacy helper)", "body": { "mode": "raw", "raw": "{\n \"ghl_location_id\": \"loc_abc123XYZ\",\n \"ghl_company_id\": \"comp_def456\",\n \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampletokenvalue\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List all GoHighLevel connections for the current user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner-end-user/connections", "host": [ "{{base_url}}" ], "path": [ "api", "partner-end-user", "connections" ] }, "description": "List all GoHighLevel connections for the current user" } }, { "name": "Add a connection for a location", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner-end-user/connections", "host": [ "{{base_url}}" ], "path": [ "api", "partner-end-user", "connections" ] }, "description": "Add a connection for a location", "body": { "mode": "raw", "raw": "{\n \"ghl_location_id\": \"loc_abc123XYZ\",\n \"ghl_company_id\": \"comp_def456\",\n \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampletokenvalue\",\n \"is_default\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update a connection you own", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner-end-user/connections/{{connection}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner-end-user", "connections", "{{connection}}" ] }, "description": "Update a connection you own", "body": { "mode": "raw", "raw": "{\n \"ghl_location_id\": \"loc_abc123XYZ\",\n \"ghl_company_id\": \"comp_def456\",\n \"access_token\": null,\n \"is_default\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove a connection you own", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner-end-user/connections/{{connection}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner-end-user", "connections", "{{connection}}" ] }, "description": "Remove a connection you own" } }, { "name": "Mark a connection as the default location", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner-end-user/connections/{{connection}}/default", "host": [ "{{base_url}}" ], "path": [ "api", "partner-end-user", "connections", "{{connection}}", "default" ] }, "description": "Mark a connection as the default location" } } ] } ] }, { "name": "Billing", "description": "End-user voice subscription packages, current plan, usage, upgrade/cancel, and card checkout.", "item": [ { "name": "Billing", "item": [ { "name": "List active subscription packages for the reseller", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/subscriptions/packages", "host": [ "{{base_url}}" ], "path": [ "api", "subscriptions", "packages" ] }, "description": "List active subscription packages for the reseller" } }, { "name": "Get the billing owner's current (or latest) subscription", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/subscriptions/current", "host": [ "{{base_url}}" ], "path": [ "api", "subscriptions", "current" ] }, "description": "Get the billing owner's current (or latest) subscription" } }, { "name": "Get assistant and minute usage for the current billing period", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/subscriptions/usage", "host": [ "{{base_url}}" ], "path": [ "api", "subscriptions", "usage" ] }, "description": "Get assistant and minute usage for the current billing period" } }, { "name": "Get a compact subscription summary by id", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/subscriptions/{{id}}", "host": [ "{{base_url}}" ], "path": [ "api", "subscriptions", "{{id}}" ] }, "description": "Get a compact subscription summary by id" } }, { "name": "Upgrade the active subscription to a higher-priced package", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/subscriptions/upgrade", "host": [ "{{base_url}}" ], "path": [ "api", "subscriptions", "upgrade" ] }, "description": "Upgrade the active subscription to a higher-priced package", "body": { "mode": "raw", "raw": "{\n \"package_id\": 4\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel the active subscription locally", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/subscriptions/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "subscriptions", "cancel" ] }, "description": "Cancel the active subscription locally" } }, { "name": "Create a local active subscription without card checkout", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/subscriptions/subscribe", "host": [ "{{base_url}}" ], "path": [ "api", "subscriptions", "subscribe" ] }, "description": "Create a local active subscription without card checkout", "body": { "mode": "raw", "raw": "{\n \"package_id\": 3\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get the publishable payment key and currency for checkout", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/stripe/config", "host": [ "{{base_url}}" ], "path": [ "api", "stripe", "config" ] }, "description": "Get the publishable payment key and currency for checkout" } }, { "name": "Create a paid subscription with a payment method", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/stripe/subscription", "host": [ "{{base_url}}" ], "path": [ "api", "stripe", "subscription" ] }, "description": "Create a paid subscription with a payment method", "body": { "mode": "raw", "raw": "{\n \"package_id\": 3,\n \"payment_method_id\": \"pm_1PxExamplePaymentMethod\",\n \"billing_interval\": \"monthly\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Team", "description": "Workspace teams — list and rename workspaces, manage members and roles, send and accept invitations.", "item": [ { "name": "Team", "item": [ { "name": "List workspaces the current user belongs to", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/workspaces", "host": [ "{{base_url}}" ], "path": [ "api", "workspaces" ] }, "description": "List workspaces the current user belongs to" } }, { "name": "Get one workspace the caller can view", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/workspaces/{{workspace}}", "host": [ "{{base_url}}" ], "path": [ "api", "workspaces", "{{workspace}}" ] }, "description": "Get one workspace the caller can view" } }, { "name": "Rename a workspace", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/workspaces/{{workspace}}", "host": [ "{{base_url}}" ], "path": [ "api", "workspaces", "{{workspace}}" ] }, "description": "Rename a workspace", "body": { "mode": "raw", "raw": "{\n \"name\": \"Acme Front Desk\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List members and pending invitations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/workspaces/{{workspace}}/members", "host": [ "{{base_url}}" ], "path": [ "api", "workspaces", "{{workspace}}", "members" ] }, "description": "List members and pending invitations" } }, { "name": "Change a member's role", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/workspaces/{{workspace}}/members/{{member}}", "host": [ "{{base_url}}" ], "path": [ "api", "workspaces", "{{workspace}}", "members", "{{member}}" ] }, "description": "Change a member's role", "body": { "mode": "raw", "raw": "{\n \"role\": \"admin\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove a member from the workspace", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/workspaces/{{workspace}}/members/{{member}}", "host": [ "{{base_url}}" ], "path": [ "api", "workspaces", "{{workspace}}", "members", "{{member}}" ] }, "description": "Remove a member from the workspace" } }, { "name": "Invite a teammate by email", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/workspaces/{{workspace}}/invitations", "host": [ "{{base_url}}" ], "path": [ "api", "workspaces", "{{workspace}}", "invitations" ] }, "description": "Invite a teammate by email", "body": { "mode": "raw", "raw": "{\n \"email\": \"newhire@example.com\",\n \"role\": \"member\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Revoke a pending invitation", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/workspaces/{{workspace}}/invitations/{{invitation}}", "host": [ "{{base_url}}" ], "path": [ "api", "workspaces", "{{workspace}}", "invitations", "{{invitation}}" ] }, "description": "Revoke a pending invitation" } }, { "name": "Preview an invitation link (public)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/workspace-invitations/{{token}}", "host": [ "{{base_url}}" ], "path": [ "api", "workspace-invitations", "{{token}}" ] }, "description": "Preview an invitation link (public)" } }, { "name": "Accept an invitation (login or register)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/workspace-invitations/accept", "host": [ "{{base_url}}" ], "path": [ "api", "workspace-invitations", "accept" ] }, "description": "Accept an invitation (login or register)", "body": { "mode": "raw", "raw": "{\n \"token\": \"plain-invite-token-from-email\",\n \"name\": \"Sam Rivera\",\n \"password\": \"a-secure-password\",\n \"password_confirmation\": \"a-secure-password\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Account", "description": "Account profile — read and update name, phone, company, bio, and profile picture; change password; read the caller's feature-permission map.", "item": [ { "name": "Profile", "item": [ { "name": "Get the authenticated user profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/user", "host": [ "{{base_url}}" ], "path": [ "api", "user" ] }, "description": "Get the authenticated user profile" } }, { "name": "Update profile fields (JSON)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/user", "host": [ "{{base_url}}" ], "path": [ "api", "user" ] }, "description": "Update profile fields (JSON)", "body": { "mode": "raw", "raw": "{\n \"name\": \"Jordan Lee\",\n \"phone\": \"+14155550123\",\n \"company\": \"Acme Dental\",\n \"bio\": \"Practice manager\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update profile fields (multipart; used by the Profile UI)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/user", "host": [ "{{base_url}}" ], "path": [ "api", "user" ] }, "description": "Update profile fields (multipart; used by the Profile UI)", "body": { "mode": "raw", "raw": "name=Jordan Lee\nphone=+14155550123\ncompany=Acme Dental\nbio=Practice manager\nprofile_picture=@portrait.jpg", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Password", "item": [ { "name": "Change the authenticated user password", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/user/password", "host": [ "{{base_url}}" ], "path": [ "api", "user", "password" ] }, "description": "Change the authenticated user password", "body": { "mode": "raw", "raw": "{\n \"current_password\": \"old-secret-pass\",\n \"new_password\": \"new-secret-pass\",\n \"new_password_confirmation\": \"new-secret-pass\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Features", "item": [ { "name": "Get the caller's feature-permission map", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/me/features", "host": [ "{{base_url}}" ], "path": [ "api", "me", "features" ] }, "description": "Get the caller's feature-permission map" } } ] } ] } ] }