The Insighto AI connector lets your AI agent act in each user's Insighto AI account. Each user connects their own Insighto AI API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 28 · 23 · 928 read23 write9 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Insighto AI connection
In AgentKit > Connections, create an Insighto AI connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'insighto'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Insighto AI:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'insighto_assistants_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "insighto"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Insighto AI:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="insighto_assistants_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Insighto AI credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolinsighto_assistant_data_sources_listList the knowledge data sources linked to an assistant.Read-onlyList Assistant Data Sources
List the knowledge data sources linked to an assistant. Returns data (items, total, page, size, pages, previous_page, next_page). Get assistant IDs from insighto_assistants_list.
Inputs
assistant_idstringrequired- Assistant ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa2
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_assistant_getGet one assistant's configuration.Read-onlyGet Assistant
Get one assistant's configuration. Returns data (assistant_type, llm_model, name, description, attributes, system_prompt, voice, custom_voice, voice_languages, org_id). Get assistant IDs from insighto_assistants_list.
Inputs
assistant_idstringrequired- Assistant ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa2
insighto_assistant_intents_listList the intents linked to an assistant.Read-onlyList Assistant Intents
List the intents linked to an assistant. Returns data (items, total, page, size, pages, previous_page, next_page). Get assistant IDs from insighto_assistants_list.
Inputs
assistant_idstringrequired- Assistant ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa2
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_assistant_widgets_listList the widgets (deployments) linked to an assistant.Read-onlyList Assistant Widgets
List the widgets (deployments) linked to an assistant. Returns data (items, total, page, size, pages, previous_page, next_page). Get assistant IDs from insighto_assistants_list.
Inputs
assistant_idstringrequired- Assistant ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa2
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_assistants_listList AI assistants with paging.Read-onlyList Assistants
List AI assistants with paging. Returns data (items, total, page, size, pages, previous_page, next_page). Use insighto_assistant_get for one assistant's configuration.
Inputs
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_campaign_getGet one campaign.Read-onlyGet Campaign
Get one campaign. Returns data (name, widget_id, type, attributes, status, execution_weekdays, time_window_start, time_window_end, time_zone, start_time). Get campaign IDs from insighto_campaigns_list.
Inputs
campaign_idstringrequired- Campaign ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa9
insighto_campaigns_listList campaigns with paging.Read-onlyList Campaigns
List campaigns with paging. Returns data (items, total, page, size, pages, previous_page, next_page). Use insighto_campaign_get for one campaign.
Inputs
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_captured_intents_listList intents captured in conversations, with paging.Read-onlyList Captured Intents
List intents captured in conversations, with paging. Returns data (items, total, page, size, pages, previous_page, next_page). Use insighto_intents_list for intent definitions.
Inputs
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_contact_conversations_listList the conversations of one contact.Read-onlyList Contact Conversations
List the conversations of one contact. Returns data (items, total, page, size, pages, previous_page, next_page). Get contact IDs from insighto_contacts_list.
Inputs
contact_idstringrequired- Contact ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa4
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_contact_getGet one contact by ID, including channels, attributes and custom fields.Read-onlyGet Contact
Get one contact by ID, including channels, attributes and custom fields. Returns data (first_name, last_name, email, channels, user_attributes, last_seen, last_sent, org_id, first_assistant_id, last_assistant_id). Get contact IDs from insighto_contacts_list.
Inputs
contact_idstringrequired- Contact ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa4
insighto_contacts_listList contacts with paging.Read-onlyList Contacts
List contacts with paging. Returns data (items, total, page, size, pages, previous_page, next_page). Use insighto_contact_get for one contact's details.
Inputs
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_conversation_getGet one conversation's details (channel, contact, assistant, status).Read-onlyGet Conversation
Get one conversation's details (channel, contact, assistant, status). Returns data (widget_id, assistant_id, device_type, unique_device_id, attributes, contact_id, id, created_at, first_message, chat_count). Use insighto_conversation_transcript_get for its messages.
Inputs
conversation_idstringrequired- Conversation ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa3
insighto_conversation_transcript_getGet the full message transcript of a conversation.Read-onlyGet Conversation Transcript
Get the full message transcript of a conversation. Get conversation IDs from insighto_conversations_list.
Inputs
conversation_idstringrequired- Conversation ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa3
insighto_conversations_listList conversations in a date range, optionally filtered by assistant or intent, with paging.Read-onlyList Conversations
List conversations in a date range, optionally filtered by assistant or intent, with paging. Returns data (items, total, page, size, pages, previous_page, next_page). Use insighto_conversation_transcript_get to read one conversation's messages.
Inputs
date_fromstringrequired- Start date (YYYY-MM-DD) of the conversation range; required. Example: 2026-01-01
date_tostringrequired- End date (YYYY-MM-DD) of the conversation range; required. Example: 2026-01-31
assistant_idstring- Assistant ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa2
includes_voiceboolean- Includes Voice. Example: true
intent_idstring- Intent ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa7
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_data_source_files_listList the files and text blobs in a data source.Read-onlyList Data Source Files
List the files and text blobs in a data source. Returns data (items, total, page, size, pages, previous_page, next_page). Get data source IDs from insighto_data_sources_list.
Inputs
datasource_idstringrequired- Datasource ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa5
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_data_source_getGet one data source.Read-onlyGet Data Source
Get one data source. Returns data (ds_type, name, description, attributes, ds_status, org_id, id). Get data source IDs from insighto_data_sources_list.
Inputs
datasource_idstringrequired- Datasource ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa5
insighto_data_sources_listList knowledge data sources with paging.Read-onlyList Data Sources
List knowledge data sources with paging. Returns data (items, total, page, size, pages, previous_page, next_page). Use insighto_data_source_files_list for a data source's contents.
Inputs
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_form_getGet one form's definition.Read-onlyGet Form
Get one form's definition. Returns data (org_id, name, trigger_instructions, form_type, attributes, fields, webhook_id, trigger_tools, contact_mapping, id). Get form IDs from insighto_forms_list.
Inputs
form_idstringrequired- Form ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa8
insighto_form_submissions_listList the data captured by a form in conversations, with paging.Read-onlyList Form Submissions
List the data captured by a form in conversations, with paging. Returns data (items, total, page, size, pages, previous_page, next_page). Get form IDs from insighto_forms_list.
Inputs
form_idstringrequired- Form ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa8
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_forms_listList forms with paging.Read-onlyList Forms
List forms with paging. Returns data (items, total, page, size, pages, previous_page, next_page). Use insighto_form_submissions_list for captured data.
Inputs
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_intent_getGet one intent.Read-onlyGet Intent
Get one intent. Returns data (name, description, attributes, is_active, id, intent_type). Get intent IDs from insighto_intents_list.
Inputs
intent_idstringrequired- Intent ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa7
insighto_intents_listList intents with paging.Read-onlyList Intents
List intents with paging. Returns data (items, total, page, size, pages, previous_page, next_page). Use insighto_captured_intents_list for detected occurrences.
Inputs
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_me_getGet the account details of the API key's user.Read-onlyGet My Account
Get the account details of the API key's user. Returns data (first_name, last_name, email, is_active, is_superuser, birthdate, is_enterprise, role_id, phone, state). Use this to check the key works.
Inputs
This tool takes no inputs.
insighto_whatsapp_templates_listList the approved WhatsApp message templates of a WhatsApp widget.Read-onlyList WhatsApp Templates
List the approved WhatsApp message templates of a WhatsApp widget. Get widget IDs from insighto_widgets_list.
Inputs
widget_idstringrequired- WhatsApp widget ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa1
insighto_widget_getGet one widget's configuration.Read-onlyGet Widget
Get one widget's configuration. Returns data (org_id, widget_type, assistant_id, name, description, attributes, display_name, intro_message, user_opening_messages, header_color). Get widget IDs from insighto_widgets_list.
Inputs
widget_idstringrequired- Widget ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa1
insighto_widgets_listList widgets with paging.Read-onlyList Widgets
List widgets with paging. Returns data (items, total, page, size, pages, previous_page, next_page). Use this to find the widget ID needed to call, message or run campaigns.
Inputs
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_workflows_listList automation workflows with paging.Read-onlyList Workflows
List automation workflows with paging. Returns data (items, total, page, size, pages, previous_page, next_page). Use insighto_workflow_trigger to run one.
Inputs
pageinteger- Page number, starting at 1. Example: 1
sizeinteger- Number of records per page. Example: 50
insighto_assistant_createCreate an AI assistant (chat or voice) with its model, system prompt and voice settings.WriteCreate Assistant
Create an AI assistant (chat or voice) with its model, system prompt and voice settings. Returns data (assistant_type, llm_model, name, description, attributes, system_prompt, voice, custom_voice, voice_languages, org_id). Link it to a widget with insighto_widget_create to deploy it.
Inputs
assistant_typestringrequired- Kind of assistant: simple or chat for text chat, phone for voice calls, nl2sql for database Q&A, realtime_openai for realtime voice. One of: simple, chat, phone, nl2sql, realtime_openai. Example: chatone of
simplechatphonenl2sqlrealtime_openai llm_modelstringrequired- Language model the assistant uses. Example: gpt-4o-minione of
gpt-4-0125-previewgpt-3.5-turbo-0125gpt-3.5-turbo-1106gpt-3.5-turbogpt-4-1106-previewgpt-4o-2024-05-13gpt-4o-minillama-3.1-70b-versatilegpt-4o-realtime-previewgpt-4o-mini-realtime-previewdeepseek-r1-distill-llama-70bo3-minigpt-5.4-mini attributesobject- Attributes. Example: {}
conversation_flow_idstring- Conversation Flow ID. Example: 12345
custom_voiceboolean- Custom Voice. Example: false
descriptionstring- Description. Example: Answers questions about our product
has_human_agentboolean- Has Human Agent. Example: false
hide_dsboolean- Hide Ds. Example: false
namestring- Name. Example: Support assistant
show_imagesboolean- Show Images. Example: false
system_promptstring- Instructions that define the assistant's behaviour and persona. Example: You are a friendly support agent for Acme.
use_toolsboolean- Use Tools. Example: false
voiceboolean- Voice. Example: false
voice_languagesarray- Voice Languages. Example: ["en-US", "de-DE", "mr-IN", "hi-IN"]
webhook_idstring- Webhook ID. Example: 12345
insighto_assistant_data_source_addLink a knowledge data source to an assistant.WriteAdd Data Source to Assistant
Link a knowledge data source to an assistant. Returns data (assistant_type, llm_model, name, description, attributes, system_prompt, voice, custom_voice, voice_languages, org_id). Get data source IDs from insighto_data_sources_list.
- Idempotent
Inputs
assistant_idstringrequired- The UUID id of the assistant. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa2
datasource_idstringrequired- Datasource ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa5
insighto_assistant_intent_addLink an intent to an assistant so it is detected in its conversations.WriteAdd Intent to Assistant
Link an intent to an assistant so it is detected in its conversations. Returns data (assistant_id, intent_id, is_active, attributes, id). Get intent IDs from insighto_intents_list.
- Idempotent
Inputs
assistant_idstringrequired- The UUID id of the assistant. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa2
intent_idstringrequired- Intent ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa7
insighto_assistant_updateUpdate an assistant's name, model, system prompt, voice or tool settings.WriteUpdate Assistant
Update an assistant's name, model, system prompt, voice or tool settings. Returns data (assistant_type, llm_model, name, description, attributes, system_prompt, voice, custom_voice, voice_languages, org_id). Get assistant IDs from insighto_assistants_list.
- Idempotent
Inputs
assistant_idstringrequired- The UUID id of the assistant. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa2
assistant_typestring- Kind of assistant: simple or chat for text chat, phone for voice calls, nl2sql for database Q&A, realtime_openai for realtime voice. One of: simple, chat, phone, nl2sql, realtime_openai. Example: chatone of
simplechatphonenl2sqlrealtime_openai attributesobject- Attributes. Example: {}
conversation_flow_idstring- Conversation Flow ID. Example: 12345
custom_voiceboolean- Custom Voice. Example: true
descriptionstring- Description. Example: Answers questions about our product
has_human_agentboolean- Has Human Agent. Example: true
hide_dsboolean- Hide Ds. Example: true
llm_modelstring- Language model the assistant uses. Example: gpt-4o-minione of
gpt-4-0125-previewgpt-3.5-turbo-0125gpt-3.5-turbo-1106gpt-3.5-turbogpt-4-1106-previewgpt-4o-2024-05-13gpt-4o-minillama-3.1-70b-versatilegpt-4o-realtime-previewgpt-4o-mini-realtime-previewdeepseek-r1-distill-llama-70bo3-minigpt-5.4-mini namestring- Name. Example: Support assistant
show_imagesboolean- Show Images. Example: true
system_promptstring- Instructions that define the assistant's behaviour and persona. Example: You are a friendly support agent for Acme.
use_toolsboolean- Use Tools. Example: true
voiceboolean- Voice. Example: true
voice_languagesarray- Voice Languages. Example: ["value"]
webhook_idstring- Webhook ID. Example: 12345
insighto_call_disconnectEnd an ongoing call.WriteDisconnect Call
End an ongoing call. Returns message, meta, data. The conversation ID is returned by insighto_call_make.
- Idempotent
Inputs
conversation_idstringrequired- Conversation ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa3
insighto_call_makePlace an outbound AI voice call to a phone number from a phone widget, optionally with dynamic prompt variables.WriteMake Outbound Call
Place an outbound AI voice call to a phone number from a phone widget, optionally with dynamic prompt variables. Returns data (conversation_id, contact_id, widget_id, assistant_id, direction, from_number, to_number, telephony_provider, prompt_dynamic_variables). Use insighto_call_disconnect to end it. Get widget IDs from insighto_widgets_list.
Inputs
tostringrequired- Recipient phone number in E.164 format. Example: +15555550100
widget_idstringrequired- Widget ID to be used for initiating the call. It must be connected to Twilio, Plivo or Telnyx. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa1
prompt_dynamic_variablesobject- Values for the {{variables}} used in the assistant's prompt, as a JSON object. Example: {"customer_name": "Jane"}
insighto_campaign_createCreate an outbound campaign with its schedule, time window and interval.WriteCreate Campaign
Create an outbound campaign with its schedule, time window and interval. Returns data (name, widget_id, type, attributes, status, execution_weekdays, time_window_start, time_window_end, time_zone, start_time). Start it with insighto_campaign_run.
Inputs
intervalintegerrequired- Delay between campaign calls, in seconds. Example: 60
namestringrequired- Name. Example: Support assistant
start_timestringrequired- When the campaign starts, ISO 8601 date-time. Example: 2026-02-01T09:00:00Z
typestringrequired- Type. One of: outbound_call. Example: outbound_callone of
outbound_call attributesobject- Attributes. Example: {}
enabledboolean- Enabled. Example: false
execution_weekdaysarray- Execution Weekdays. Example: [1, 2, 3, 4, 5]
statusstring- Status. One of: not_started, to_be_run, in_progress, paused, cancelled, completed. Example: not_startedone of
not_startedto_be_runin_progresspausedcancelledcompleted time_window_endstring- Time Window End. Example: 17:00
time_window_startstring- Time Window Start. Example: 09:00
time_zonestring- Time Zone. Example: America/New_York
widget_idstring- Widget ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa1
insighto_campaign_runRun an outbound campaign now: call or message a list of contacts through a widget.WriteRun Campaign
Run an outbound campaign now: call or message a list of contacts through a widget. Use insighto_message_send for one recipient. Get widget IDs from insighto_widgets_list.
Inputs
contact_idsarrayrequired- IDs of the contacts to call or message, from insighto_contacts_list. Example: ["3fa85f64-5717-4562-b3fc-2c963f66afa4"]
widget_idstringrequired- Widget ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa1
messagestring- Text of the message to send. Example: Hi Jane, your appointment is confirmed for tomorrow at 10am.
start_new_conversationboolean- (Always True for calling campaigns) Start a brand‑new thread instead of replying in the existing one. Example: true
insighto_campaign_updateUpdate a campaign's name, schedule, status or settings.WriteUpdate Campaign
Update a campaign's name, schedule, status or settings. Returns data (name, widget_id, type, attributes, status, execution_weekdays, time_window_start, time_window_end, time_zone, start_time). Get campaign IDs from insighto_campaigns_list.
- Idempotent
Inputs
campaign_idstringrequired- Campaign ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa9
attributesobject- Attributes. Example: {}
enabledboolean- Enabled. Example: true
execution_weekdaysarray- Execution Weekdays. Example: [1, 2, 3, 4, 5]
intervalinteger- Delay between campaign calls, in seconds. Example: 60
namestring- Name. Example: Support assistant
start_timestring- When the campaign starts, ISO 8601 date-time. Example: 2026-02-01T09:00:00Z
statusstring- Status. One of: not_started, to_be_run, in_progress, paused, cancelled, completed. Example: not_startedone of
not_startedto_be_runin_progresspausedcancelledcompleted time_window_endstring- Time Window End. Example: 17:00
time_window_startstring- Time Window Start. Example: 09:00
time_zonestring- Time Zone. Example: America/New_York
typestring- Type. One of: outbound_call. Example: outbound_callone of
outbound_call widget_idstring- Widget ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa1
insighto_contact_updateUpdate a contact's name, email, channels, attributes or custom fields.WriteUpdate Contact
Update a contact's name, email, channels, attributes or custom fields. Returns data (first_name, last_name, email, channels, user_attributes, last_seen, last_sent, org_id, first_assistant_id, last_assistant_id). Use insighto_contact_upsert to create a contact.
- Idempotent
Inputs
contact_idstringrequired- Contact ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa4
channelsobject- Contact channels (such as phone numbers or messaging handles), as a JSON object. Example: {"key": "value"}
custom_fieldsobject- Values for contact custom fields, as a JSON object keyed by field name. Example: {"key": "value"}
emailstring- Email. Example: jane@example.com
first_assistant_idstring- First Assistant ID. Example: 12345
first_namestring- First Name. Example: Jane
first_widget_idstring- First Widget ID. Example: 12345
last_assistant_idstring- Last Assistant ID. Example: 12345
last_namestring- Last Name. Example: Doe
last_seenstring- Last Seen. Example: 2026-01-15T09:00:00Z
last_sentstring- Last Sent. Example: 2026-01-15T09:00:00Z
last_widget_idstring- Last Widget ID. Example: 12345
user_attributesobject- User Attributes. Example: {"key": "value"}
insighto_contact_upsertCreate a contact, or update the existing one with the same email or phone number.WriteUpsert Contact
Create a contact, or update the existing one with the same email or phone number. Returns data (first_name, last_name, email, channels, user_attributes, last_seen, last_sent, org_id, first_assistant_id, last_assistant_id). Use insighto_contact_update to change other fields of a known contact.
Inputs
emailstringrequired- Email. Example: jane@example.com
first_namestringrequired- First Name. Example: Jane
last_namestringrequired- Last Name. Example: Doe
phone_numberstringrequired- Phone Number. Example: +15555550100
insighto_conversation_ai_pausePause or resume the AI assistant's replies in a conversation, for example to let a human take over.WritePause or Resume AI in Conversation
Pause or resume the AI assistant's replies in a conversation, for example to let a human take over. Returns data (widget_id, assistant_id, device_type, unique_device_id, attributes, contact_id, id, created_at, first_message, chat_count). Set ai_paused false to resume.
- Idempotent
Inputs
ai_pausedbooleanrequired- true pauses the AI's replies in the conversation (a human takes over); false resumes them. Example: true
conversation_idstringrequired- Conversation ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa3
insighto_conversation_closeClose an open conversation.WriteClose Conversation
Close an open conversation. Returns data (widget_id, assistant_id, device_type, unique_device_id, attributes, contact_id, id, created_at, first_message, chat_count). Get conversation IDs from insighto_conversations_list.
- Idempotent
Inputs
conversation_idstringrequired- Conversation ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa3
insighto_data_source_createCreate a knowledge data source container.WriteCreate Data Source
Create a knowledge data source container. Returns data (ds_type, name, description, attributes, ds_status, org_id, id). Add text to it with insighto_data_source_text_add, then link it with insighto_assistant_data_source_add.
Inputs
ds_typestringrequired- Data source type. Use text_blob for plain text added with insighto_data_source_text_add. One of: pdf, doc, http, tool, text_blob, image, text_image. Example: text_blobone of
pdfdochttptooltext_blobimagetext_image attributesobject- Attributes. Example: {}
descriptionstring- Description. Example: Answers questions about our product
ds_statusstring- Ds Status. One of: empty, initialized, queued, crawling, in_process, retry_pending, ready_for_use, failed. Example: emptyone of
emptyinitializedqueuedcrawlingin_processretry_pendingready_for_usefailed namestring- Name. Example: Support assistant
insighto_data_source_text_addAdd a text blob entry to a data source for the assistant to learn from.WriteAdd Text to Data Source
Add a text blob entry to a data source for the assistant to learn from. Returns data (ds_type, name, description, attributes, org_id, id). Use insighto_data_source_files_list to see existing entries.
Inputs
datasource_idstringrequired- Datasource ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa5
ds_typestringrequired- Data source type. Use text_blob for plain text added with insighto_data_source_text_add. One of: pdf, doc, http, tool, text_blob, image, text_image. Example: text_blobone of
pdfdochttptooltext_blobimagetext_image descriptionstring- Description. Example: Answers questions about our product
namestring- Name. Example: Support assistant
insighto_form_createCreate a form the assistant fills in during a conversation, with its fields and trigger instructions.WriteCreate Form
Create a form the assistant fills in during a conversation, with its fields and trigger instructions. Returns data (org_id, name, trigger_instructions, form_type, attributes, fields, webhook_id, trigger_tools, contact_mapping). Read submissions with insighto_form_submissions_list.
Inputs
form_typestringrequired- How the form is filled: simple asks the fields directly; natural collects them conversationally. One of: natural, simple. Example: simpleone of
naturalsimple namestringrequired- Name. Example: Support assistant
trigger_instructionsstringrequired- When the assistant should start collecting this form, in plain language. Example: Collect the visitor's name and email when they ask for a demo.
attributesobject- Attributes. Example: {}
contact_mappingobject- Contact Mapping. Example: {"key": "value"}
fieldsarray- Form fields to capture, as a JSON array of objects with a name, a type and whether it is required. Example: [{"name": "email", "type": "email", "required": true}]
trigger_toolsarray- Trigger Tools. Example: ["value"]
webhook_idstring- Webhook ID. Example: 12345
insighto_form_updateUpdate a form's name, fields or trigger instructions.WriteUpdate Form
Update a form's name, fields or trigger instructions. Returns data (org_id, name, trigger_instructions, form_type, attributes, fields, webhook_id, trigger_tools, contact_mapping). Get form IDs from insighto_forms_list.
- Idempotent
Inputs
form_idstringrequired- Form ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa8
attributesobject- Attributes. Example: {}
contact_mappingobject- Contact Mapping. Example: {"key": "value"}
fieldsarray- Form fields to capture, as a JSON array of objects with a name, a type and whether it is required. Example: [{"name": "email", "type": "email", "required": true}]
form_typestring- How the form is filled: simple asks the fields directly; natural collects them conversationally. One of: natural, simple. Example: simpleone of
naturalsimple namestring- Name. Example: Support assistant
trigger_instructionsstring- When the assistant should start collecting this form, in plain language. Example: Collect the visitor's name and email when they ask for a demo.
trigger_toolsarray- Trigger Tools. Example: ["value"]
webhook_idstring- Webhook ID. Example: 12345
insighto_intent_createCreate an intent to detect in conversations, such as a demo request.WriteCreate Intent
Create an intent to detect in conversations, such as a demo request. Returns data (name, description, attributes, is_active, id, intent_type). Link it with insighto_assistant_intent_add.
Inputs
attributesobject- Attributes. Example: {}
descriptionstring- Description. Example: Answers questions about our product
intent_typestring- Intent Type. Example: user
is_activeboolean- Is Active. Example: true
namestring- Name. Example: Support assistant
insighto_message_sendSend a message (for example SMS or WhatsApp) to a phone number or contact through a widget.WriteSend Message
Send a message (for example SMS or WhatsApp) to a phone number or contact through a widget. Use insighto_campaign_run to message many contacts. Get widget IDs from insighto_widgets_list.
Inputs
widget_idstringrequired- Widget ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa1
contact_idstring- Contact ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa4
conversation_idstring- Conversation ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa3
messagestring- Text of the message to send. Example: Hi Jane, your appointment is confirmed for tomorrow at 10am.
start_new_conversationboolean- Start New Conversation. Example: true
tostring- Recipient phone number in E.164 format. Example: +15555550100
widget_parametersobject- Widget Parameters. Example: {"key": "value"}
insighto_tag_createCreate a tag with a name, description and color.WriteCreate Tag
Create a tag with a name, description and color. Returns data (name, description, color_code, attributes, id). Use insighto_tags_list to see existing tags.
Inputs
color_codestringrequired- Tag color as a hex code. Example: #3b82f6
descriptionstringrequired- Description. Example: Answers questions about our product
namestringrequired- Name. Example: Support assistant
attributesobject- Attributes. Example: {}
insighto_widget_createCreate a widget: a deployment of an assistant on a channel such as web chat, phone or WhatsApp.WriteCreate Widget
Create a widget: a deployment of an assistant on a channel such as web chat, phone or WhatsApp. Returns data (org_id, widget_type, assistant_id, name, description, attributes, display_name, intro_message, user_opening_messages, header_color). Create the assistant first with insighto_assistant_create.
Inputs
action_buttonsarrayrequired- Action buttons shown in the widget, as a JSON array (can be empty). Example: []
user_opening_messagesarrayrequired- Suggested opening messages shown to the visitor, as a JSON array of strings. Example: ["Hi! How can I help?"]
widget_typestringrequired- Channel the widget deploys the assistant on, such as chat (web chat), whatsapp, sms, phone, web_call or telegram. Example: chatone of
chathtmlwhatsappphonehtml_callleadconnectorleadconnector_callsmsfb_messengerinstagramweb_callplivo_calltelnyx_calltelegramrender_formsip assistant_idstring- Assistant ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa2
attributesobject- Attributes. Example: {}
descriptionstring- Description. Example: Answers questions about our product
display_namestring- Display Name. Example: Example name
intro_messagestring- Intro Message. Example: example
namestring- Name. Example: Support assistant
insighto_widget_updateUpdate a widget's assistant, name, messages or buttons.WriteUpdate Widget
Update a widget's assistant, name, messages or buttons. Returns data (org_id, widget_type, assistant_id, name, description, attributes, display_name, intro_message, user_opening_messages, header_color). Get widget IDs from insighto_widgets_list.
- Idempotent
Inputs
widget_idstringrequired- Widget ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa1
widget_typestringrequired- Channel the widget deploys the assistant on, such as chat (web chat), whatsapp, sms, phone, web_call or telegram. Example: chatone of
chathtmlwhatsappphonehtml_callleadconnectorleadconnector_callsmsfb_messengerinstagramweb_callplivo_calltelnyx_calltelegramrender_formsip action_buttonsarray- Action buttons shown in the widget, as a JSON array (can be empty). Example: []
assistant_idstring- Assistant ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa2
attributesobject- Attributes. Example: {}
descriptionstring- Description. Example: Answers questions about our product
display_namestring- Display Name. Example: Example name
intro_messagestring- Intro Message. Example: example
namestring- Name. Example: Support assistant
user_opening_messagesarray- Suggested opening messages shown to the visitor, as a JSON array of strings. Example: ["Hi! How can I help?"]
insighto_workflow_triggerRun an automation workflow with an optional trigger payload.WriteTrigger Workflow
Run an automation workflow with an optional trigger payload. Returns data (workflow_id, workflow_version, trigger_payload, context, current_node_id, status, started_at, finished_at, error, id). Get workflow IDs from insighto_workflows_list.
Inputs
workflow_idstringrequired- Workflow ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afb1
trigger_payloadobject- Data passed to the workflow's trigger, as a JSON object. Example: {"contact_id": "3fa85f64-5717-4562-b3fc-2c963f66afa4"}
insighto_assistant_deleteDelete an assistant.DestructiveDelete Assistant
Delete an assistant. Get assistant IDs from insighto_assistants_list.
- Idempotent
Inputs
assistant_idstringrequired- The UUID id of the assistant. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa2
insighto_campaign_deleteDelete a campaign.DestructiveDelete Campaign
Delete a campaign. Get campaign IDs from insighto_campaigns_list.
- Idempotent
Inputs
campaign_idstringrequired- Campaign ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa9
insighto_contact_deleteDelete a contact.DestructiveDelete Contact
Delete a contact. Get contact IDs from insighto_contacts_list.
- Idempotent
Inputs
contact_idstringrequired- Contact ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa4
insighto_conversation_deleteDelete a conversation and its transcript.DestructiveDelete Conversation
Delete a conversation and its transcript. Get conversation IDs from insighto_conversations_list.
- Idempotent
Inputs
conversation_idstringrequired- Conversation ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa3
insighto_data_source_deleteDelete a data source and its files.DestructiveDelete Data Source
Delete a data source and its files. Get data source IDs from insighto_data_sources_list.
- Idempotent
Inputs
datasource_idstringrequired- Datasource ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa5
insighto_data_source_file_deleteDelete one file or text blob from a data source.DestructiveDelete Data Source File
Delete one file or text blob from a data source. Get file IDs from insighto_data_source_files_list.
- Idempotent
Inputs
datasourcefile_idstringrequired- Datasourcefile ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
insighto_form_deleteDelete a form.DestructiveDelete Form
Delete a form. Get form IDs from insighto_forms_list.
- Idempotent
Inputs
form_idstringrequired- Form ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa8
insighto_intent_deleteDelete an intent.DestructiveDelete Intent
Delete an intent. Get intent IDs from insighto_intents_list.
- Idempotent
Inputs
intent_idstringrequired- Intent ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa7
insighto_widget_deleteDelete a widget.DestructiveDelete Widget
Delete a widget. Get widget IDs from insighto_widgets_list.
- Idempotent
Inputs
widget_idstringrequired- Widget ID. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa1
No tools match.