Insighto.ai

https://docs.insighto.ai/
Admin
Insighto.ai is a platform for building voice and chat AI agents that connect to tools, knowledge...
Tokens:143,901
Snippets:1,394
Trust Score:9.4
Update:23 hours ago
Show doc for...
Tokens:
Raw
### Response 200 Example

Source: https://docs.insighto.ai/api/make-calls-to-contacts-api-v-1-call-widget-id-contacts-post

Example response body when the campaign has been queued.

```json
{
  "status": "Campaign has been queued"
}
```

--------------------------------

### Request Body Example (Collapsed)

Source: https://docs.insighto.ai/api/make-calls-to-contacts-api-v-1-call-widget-id-contacts-post

Example request body shown in the collapsed request section. It uses placeholder values for message and start_new_conversation.

```json
{
  "contact_ids": [
    "a3ae8c0f-2e9d-4c18-8c0e-d510e3cacb04",
    "8a849d72-93cf-4e6c-b1a3-6c10d4c65f1d"
  ],
  "message": "string",
  "start_new_conversation": true
}
```

--------------------------------

### Response example for 429 - Too Many Requests

Source: https://docs.insighto.ai/api/disconnect-call-api-v-1-call-disconnect-conversation-id-patch

Example response body for rate limiting.

```json
{
  "detail": "string"
}
```

```json
{
  "detail": "Too Many Requests"
}
```

--------------------------------

### Response example for 200 - Call disconnect initiated

Source: https://docs.insighto.ai/api/disconnect-call-api-v-1-call-disconnect-conversation-id-patch

Example response body for a successful disconnect request.

```json
{
  "message": "string",
  "meta": {}
}
```

```json
{
  "status": "Call disconnect initiated"
}
```

--------------------------------

### Example invocation of lookup_value_one

Source: https://docs.insighto.ai/tools/postgres

JSON object showing how to call the lookup_value_one function with a lookup_key argument. The example uses 'ORD-12345' as the lookup key.

```json
{
  "function": "lookup_value_one",
  "arguments": {
    "lookup_key": "ORD-12345"
  }
}
```

--------------------------------

### Response 429 Schema Example

Source: https://docs.insighto.ai/api/make-calls-to-contacts-api-v-1-call-widget-id-contacts-post

Example response schema for too many requests, with a detail field.

```json
{
  "detail": "string"
}
```

--------------------------------

### Example result returned by lookup_value_one

Source: https://docs.insighto.ai/tools/postgres

Text output showing the format of the returned row when a match is found. The example assumes lookup_table = orders and identifier columns [order_number, customer_email].

```text
id: 412
order_number: ORD-12345
customer_email: alice@example.com
status: shipped
total_cents: 4999
created_at: 2026-05-10 14:30:00
shipped_at: 2026-05-12 09:15:00
tracking_url: https://carrier.com/track/abc
```

--------------------------------

### Success Response Example for Make a Call API

Source: https://docs.insighto.ai/api/make-a-call-api-v-1-call-widget-id-post

Example JSON response for a successful call initiation (HTTP 201). Contains conversation, contact, widget, assistant IDs, call direction, phone numbers, telephony provider details, and dynamic variables.

```json
{
  "message": "string",
  "meta": {},
  "data": {
    "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "contact_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "widget_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "assistant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "direction": "string",
    "from_number": "string",
    "to_number": "string",
    "telephony_provider": {
      "provider_name": "twilio",
      "call_id": "string",
      "response_body": {}
    },
    "prompt_dynamic_variables": {}
  }
}
```

--------------------------------

### Example request body for Make a Call API

Source: https://docs.insighto.ai/api/make-a-call-api-v-1-call-widget-id-post

JSON body example for the Make a Call API. The 'to' field must be in E.164 format (e.g., 16501234567). The 'prompt_dynamic_variables' object is optional and can be null.

```json
{
  "prompt_dynamic_variables": {
    "appointment_day": "tomorrow",
    "name": "Bob",
    "reason": "for confirmation of appointment"
  },
  "to": "919810012345"
}
```

--------------------------------

### Request Body Example for Bulk Calling

Source: https://docs.insighto.ai/api/make-calls-to-contacts-api-v-1-call-widget-id-contacts-post

Example JSON body for the bulk calling request. contact_ids is required and must contain at least one UUID. message is only for chat-based assistants and ignored for calling. start_new_conversation is always true for calling campaigns.

```json
{
  "contact_ids": [
    "a3ae8c0f-2e9d-4c18-8c0e-d510e3cacb04",
    "8a849d72-93cf-4e6c-b1a3-6c10d4c65f1d"
  ],
  "message": "Hi Adam, check out our new offer!",
  "start_new_conversation": true
}
```

--------------------------------

### Response 200 Schema Example

Source: https://docs.insighto.ai/api/make-calls-to-contacts-api-v-1-call-widget-id-contacts-post

Example response schema for a successful campaign queued response. The response includes message and meta fields.

```json
{
  "message": "string",
  "meta": {}
}
```

--------------------------------

### get_earliest_appointments

Source: https://docs.insighto.ai/tools/gohighlevel

Five-day window starting from today (or from a given date).

```APIDOC
## get_earliest_appointments

### Description
Five-day window starting from today (or from a given date).

### Arguments
- **appointment_date** (string, optional) - Date in `YYYY-MM-DD` format.

### Returns
- The next several open slot strings.
```

--------------------------------

### Working hours configuration with multi-window days

Source: https://docs.insighto.ai/tools/google-calendar

Example JSON configuration for working hours per day, supporting multiple windows per day.

```json
{
  "Monday": ["09:00-12:30", "14:00-17:00"],
  "Tuesday": ["10:00-17:00"],
  "Wednesday": ["09:00-11:30", "14:00-17:00"]
}
```

--------------------------------

### Example prompt template body

Source: https://docs.insighto.ai/build/library/prompts

Shows the template body syntax with {{variable_name}} placeholders for linked variables and {system.date_yyyy_mm_dd} for the current date. {{contact.first_name}} is filled per call from the matched contact.

```text
You are {{assistant_role}} for {{business_name}}.

Your job is to greet the caller, identify why they are calling,
and either book an appointment or transfer to a human.

Hours: {{office_hours}}
Address: {{office_address}}
Today is {system.date_yyyy_mm_dd}.

Tone: warm, concise, never robotic.

When the caller wants to book, collect their name, phone, and
preferred slot, then call book_appointment.

If the caller asks something outside scope, say "Let me get
someone to help with that" and call transfer_to_human.

{{contact.first_name}} — say their name once if available.
```

--------------------------------

### Response example for 422 - Validation Error

Source: https://docs.insighto.ai/api/disconnect-call-api-v-1-call-disconnect-conversation-id-patch

Example response body for a validation error.

```json
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
```

--------------------------------

### B2B SaaS sales qualifier (chat) system prompt

Source: https://docs.insighto.ai/build/assistants/system-prompt

Full example prompt for a chat-based sales qualifier. Includes qualification questions, constraints on response length and tone, and actions book_demo and save_lead based on lead fit.

```text
You are a sales development assistant for Acme Analytics.

Your job is to qualify inbound leads and book a demo when they fit.

You have a knowledge base on Acme's product, pricing tiers, and case
studies. You can call book_demo(email, company, use_case) and
save_lead(email, company, qualification_notes).

Constraints:
- Direct and friendly. No emojis. No exclamation marks.
- Two to four sentences per response.
- Do not pitch features unprompted. Ask about their problem first.

Qualification questions (ask one at a time):
- What is your team doing today for analytics?
- How big is the team that would use this?
- What is the problem that brought you here?

When the lead is qualified (10+ person team, real use case),
call book_demo.

When the lead is not a fit, thank them and call save_lead.

```

--------------------------------

### GoHighLevel placeholders in system prompt

Source: https://docs.insighto.ai/build/data-sources/connect-crm

Use the leadconnector prefix for GoHighLevel CRM placeholders in the system prompt.

```text
Caller context:
- Name: {{leadconnector.first_name}}
- Pipeline stage: {{leadconnector.pipeline_stage}}
```

--------------------------------

### GET /api/v1/calendar_pool/{id}/available_slots

Source: https://docs.insighto.ai/automation/calendar-pools

Gets available slots for a calendar pool within a date range.

```APIDOC
## GET /api/v1/calendar_pool/{id}/available_slots

### Description
Gets available slots for a calendar pool within a date range, as a union across members.

### Method
GET

### Endpoint
/api/v1/calendar_pool/{id}/available_slots

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the calendar pool.

#### Query Parameters
- **start_date** (string) - Required - Start date in YYYY-MM-DD format.
- **end_date** (string) - Required - End date in YYYY-MM-DD format.

### Response
#### Success Response (200)
- **slots** (array) - List of available slots.

#### Response Example
```json
{
  "slots": []
}
```
```

--------------------------------

### Curl Example for Make a Call API

Source: https://docs.insighto.ai/api/make-a-call-api-v-1-call-widget-id-post

Curl command to initiate a call. Uses the API key as a query parameter, sends JSON body with prompt_dynamic_variables and destination phone number.

```bash
curl -L 'https://docs.insighto.ai/api/v1/call/:widget_id?api_key=%3Capi_key%3E' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "prompt_dynamic_variables": {
    "appointment_day": "tomorrow",
    "name": "Bob",
    "reason": "for confirmation of appointment"
  },
  "to": "919810012345"
}'
```

--------------------------------

### GET /api/v1/datasource/:datasource_id/assistants

Source: https://docs.insighto.ai/api/get-list-of-assistants-for-datasource-id-api-v-1-datasource-datasource-id-assistants-get

Gets assistants for a given datasource. The datasource ID is provided as a path parameter.

```APIDOC
## GET /api/v1/datasource/:datasource_id/assistants

### Description
Gets assistants for a given datasource.

### Method
GET

### Endpoint
/api/v1/datasource/:datasource_id/assistants

### Parameters
#### Path Parameters
- **datasource_id** (string) - Required - The unique identifier of the datasource.

### Responses
#### Success Response (200)
Successful Response

#### Validation Error (422)
Validation Error
```

--------------------------------

### Tier-1 support with retrieval (chat) system prompt

Source: https://docs.insighto.ai/build/assistants/system-prompt

Full example prompt for a chat-based tier-1 support agent. Uses knowledge base retrieval, escalates via transfer_to_human, and creates tickets with create_ticket when needed.

```text
You are a Tier 1 support agent for Helix CRM.

Your job is to resolve common questions using the knowledge base.
When you cannot resolve an issue, escalate to a human.

You have a knowledge base of help articles. You can call
create_ticket(email, subject, body) and transfer_to_human.

Constraints:
- Helpful, calm, direct.
- Two or three short paragraphs maximum.
- Never make up steps not in the knowledge base.

When the user reports a bug or expresses frustration, call
transfer_to_human.

If the answer is not in your knowledge base, say so and offer to
create a ticket. Do not guess.

```

--------------------------------

### GET /api/v1/agency/:agency_id

Source: https://docs.insighto.ai/api/get-agency-id-by-id-api-v-1-agency-agency-id-get

Gets an agency by its id. The endpoint requires the agency ID as a path parameter and returns the agency details.

```APIDOC
## GET /api/v1/agency/:agency_id

### Description
Gets an agency by its id.

### Method
GET

### Endpoint
/api/v1/agency/:agency_id

### Parameters
#### Path Parameters
- **agency_id** (string) - Required - The unique identifier of the agency.

### Responses
#### Success Response (200)
Successful Response

#### Validation Error (422)
Validation Error
```

--------------------------------

### initiate_handoff

Source: https://docs.insighto.ai/tools/disconnect-and-transfer

Sends the caller a link via SMS or WhatsApp template to a pre-configured sub-conversation on another channel. Requires smart handoff settings to be configured on the tool connection.

```APIDOC
## initiate_handoff

### Description
Sends the caller a link (via SMS or WhatsApp template) to a pre-configured sub-conversation on another channel. This allows the customer to fill in information that the voice agent cannot ask for verbally, such as long forms, file uploads, or secure inputs.

### Arguments
- **phone_number** (string, optional) - Recipient phone for the link. If omitted, the contact already known to the assistant is used.

### Returns
- Returns "Handoff completed successfully." on send.
- If smart handoff settings are not configured, returns "Handoff not configured for this call."
```

--------------------------------

### POST /api/v1/datasource

Source: https://docs.insighto.ai/build/data-sources/upload-files

Creates a new data source. This is the first step in uploading a file.

```APIDOC
## POST /api/v1/datasource

### Description
Creates a new data source. This is the first step in uploading a file.

### Method
POST

### Endpoint
https://api.insighto.ai/api/v1/datasource

### Parameters
#### Request Body
- **name** (string) - Required - The name of the data source.
- **ds_type** (string) - Required - The type of the data source (e.g., "pdf").

### Request Example
{
  "name": "clinic-policies-2026",
  "ds_type": "pdf"
}

### Response
#### Success Response (200)
- **id** (string) - The ID of the created data source.

#### Response Example
{
  "id": "<id>"
}
```

--------------------------------

### Create data source and attach file via API

Source: https://docs.insighto.ai/build/data-sources/upload-files

Use these curl commands to create a data source and attach a file. The first command creates a data source with name 'clinic-policies-2026' and type 'pdf'. The second attaches a file to the data source using the data source ID. Replace $TOKEN and paths accordingly.

```bash
# Create the data source
curl -X POST https://api.insighto.ai/api/v1/datasource \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"name": "clinic-policies-2026", "ds_type": "pdf"}'

# Attach the file
curl -X POST https://api.insighto.ai/api/v1/datasource/<id>/file \
  -H "Authorization: Bearer $TOKEN" \
  -F "datasourcefile_file=@/path/to/policies.pdf" \
  -F "ds_type=pdf" \
  -F "name=policies.pdf"
```

--------------------------------

### GET /api/v1/contact_custom_field/:contact_custom_field_id

Source: https://docs.insighto.ai/api/get-user-provider-key-by-id-api-v-1-contact-custom-field-contact-custom-field-id-get

Gets a contact custom field by its ID. The endpoint requires the contact_custom_field_id as a path parameter and returns the field data on success.

```APIDOC
## GET /api/v1/contact_custom_field/:contact_custom_field_id

### Description
Gets a contact custom field by its ID.

### Method
GET

### Endpoint
/api/v1/contact_custom_field/:contact_custom_field_id

### Parameters
#### Path Parameters
- **contact_custom_field_id** (string) - Required - The ID of the contact custom field to retrieve.

### Responses
#### Success Response (200)
Successful Response

#### Error Response (422)
Validation Error
```

--------------------------------

### GET /api/v1/agency/analytics/:agency_id/overview

Source: https://docs.insighto.ai/api/agency-overview-api-v-1-agency-analytics-agency-id-overview-get

Retrieves summary metrics for the agency for the current calendar month. This endpoint is used to get an overview of the agency's performance.

```APIDOC
## GET /api/v1/agency/analytics/:agency_id/overview

### Description
Summary metrics for the agency for the current calendar month.

### Method
GET

### Endpoint
/api/v1/agency/analytics/:agency_id/overview

### Parameters
#### Path Parameters
- **agency_id** (string) - Required - The unique identifier of the agency.

### Responses
#### Success Response (200)
Successful Response

#### Validation Error (422)
Validation Error

```

--------------------------------

### Template variable example

Source: https://docs.insighto.ai/build/assistants/system-prompt

Shows the substitution-only template variable syntax. Tokens with no value resolve to an empty string. Use double braces for contact, CRM, and library variables; single braces for system date/time.

```text
Hi {{contact.first_name}}, welcome back to Acme.
Today is {system.date_yyyy_mm_dd}.
Your current plan: {{hubspot.product_tier}}.

```

--------------------------------

### GET /api/v1/agency/billing/:agency_id/billing_plan/list

Source: https://docs.insighto.ai/api/get-agency-users-by-id-api-v-1-agency-billing-agency-id-billing-plan-list-get

Retrieves the agency users for the specified agency. This endpoint is used to get the list of users associated with the agency's billing plan.

```APIDOC
## GET /api/v1/agency/billing/:agency_id/billing_plan/list

### Description
Get the agency users

### Method
GET

### Endpoint
/api/v1/agency/billing/:agency_id/billing_plan/list

### Parameters
#### Path Parameters
- **agency_id** (string) - Required - The ID of the agency.

### Response
#### Success Response (200)
Successful Response

#### Error Response (422)
Validation Error
```

--------------------------------

### find_available_slots result with available time slots

Source: https://docs.insighto.ai/tools/google-calendar

Example JSON response from find_available_slots showing available time slots, duration, and timezone.

```json
{
  "available_time_slots": ["2026-05-20 09:00", "2026-05-20 09:30", "2026-05-20 13:00"],
  "duration_in_minutes": 30,
  "timezone": "America/New_York"
}
```

--------------------------------

### Webhook payload envelope JSON example

Source: https://docs.insighto.ai/settings/webhooks

Example of the JSON envelope for every webhook payload. The 'id' field is unique per delivery and should be used to de-duplicate events in your handler.

```json
{
  "id": "01902b1f-9e1f-7c2a-9e23-3f8c0b9a2c4d",
  "object": "event",
  "event": "conversation.closed",
  "created_at": "2026-05-14 09:32:11",
  "data": {
    "conversation_id": "01902b1d-...",
    "assistant_id": "01902b1c-...",
    "transcript": [
      { "role": "user", "content": "..." },
      { "role": "assistant", "content": "..." }
    ],
    "billing_details": {
      "billing_type": "voice",
      "billing_used": "wallet",
      "call_duration": 312,
      "voice_multiplier": 1,
      "llm_model": "gpt-4o-mini",
      "price_per_minute": 0.06,
      "utilized_wallet_balance": 0.312
    },
    "conversation_billed_to": "wallet",
    "intent_name": "qualified_lead"
  }
}
```

--------------------------------

### Order lookup response JSON

Source: https://docs.insighto.ai/tools/custom-tool

Example response returned by the custom tool endpoint. Contains order status, shipping timestamp, tracking URL, and items.

```json
{
  "order_number": "ORD-12345",
  "status": "shipped",
  "shipped_at": "2026-05-10T14:30:00Z",
  "tracking_url": "https://carrier.com/track/abc",
  "items": [{ "name": "Blue Widget", "qty": 2 }]
}
```

--------------------------------

### GET /api/v1/agency/billing/:agency_id/setup_stripe_webhook

Source: https://docs.insighto.ai/api/agency-setup-stripe-webhook-api-v-1-agency-billing-agency-id-setup-stripe-webhook-get

Sets up a Stripe webhook for the specified agency. The agency ID is provided as a path parameter. Returns a success response or a validation error.

```APIDOC
## GET /api/v1/agency/billing/:agency_id/setup_stripe_webhook

### Description
Sets up a Stripe webhook for the specified agency.

### Method
GET

### Endpoint
/api/v1/agency/billing/:agency_id/setup_stripe_webhook

### Parameters
#### Path Parameters
- **agency_id** (string) - Required - The unique identifier of the agency.

### Response
#### Success Response (200)
Successful Response

#### Validation Error (422)
Validation Error
```

--------------------------------

### conversation.closed webhook payload example

Source: https://docs.insighto.ai/webhooks-reference/conversation-closed

Example JSON payload for the conversation.closed event. The envelope includes id, object, event, created_at, and data with conversation details, transcript, and attributes. Use this to parse the event in your receiver.

```json
{
  "id": "evt_01HXXXX...",
  "object": "event",
  "event": "conversation.closed",
  "created_at": "2026-05-14T10:21:33Z",
  "data": {
    "conversation_id": "conv_01HX...",
    "assistant_id": "asst_01HX...",
    "widget_id": "wid_01HX...",
    "device_type": "web",
    "contact_id": "cnt_01HX...",
    "chat_count": 12,
    "first_message": "Hi, do you have this dress in size 8?",
    "transcript": [
      { "role": "user", "content": "Hi, do you have this dress in size 8?", "ts": "2026-05-14T10:18:01Z" },
      { "role": "assistant", "content": "Yes — both navy and cream are in stock. Want the link?", "ts": "2026-05-14T10:18:04Z" }
    ],
    "attributes": {
      "utm_source": "instagram_ads",
      "lead_score": 78
    }
  }
}
```

--------------------------------

### GET /api/v1/tool_function_invoke_log/:tool_function_invoke_log_id

Source: https://docs.insighto.ai/api/get-tool-function-invoke-log-id-api-v-1-tool-function-invoke-log-tool-function-invoke-log-id-get

Gets tool_function_invoke_log by its id. This endpoint returns the log details for the specified ID. A successful request returns a 200 status code, while an invalid ID returns a 422 validation error.

```APIDOC
## GET /api/v1/tool_function_invoke_log/:tool_function_invoke_log_id

### Description
Gets tool_function_invoke_log by its id.

### Method
GET

### Endpoint
/api/v1/tool_function_invoke_log/:tool_function_invoke_log_id

### Parameters
#### Path Parameters
- **tool_function_invoke_log_id** (string) - Required - The unique identifier of the tool function invoke log.

### Responses
#### Success Response (200)
Successful Response

#### Validation Error (422)
Validation Error
```

--------------------------------

### GET /api/v1/calendar_pool

Source: https://docs.insighto.ai/automation/calendar-pools

Lists all calendar pools.

```APIDOC
## GET /api/v1/calendar_pool

### Description
Lists your calendar pools.

### Method
GET

### Endpoint
/api/v1/calendar_pool

### Response
#### Success Response (200)
- **pools** (array) - List of calendar pools.

#### Response Example
```json
{
  "pools": []
}
```
```

--------------------------------

### POST /api/v1/user/create_live_agent

Source: https://docs.insighto.ai/api/create-live-agent-api-v-1-user-create-live-agent-post

Creates a new user with role agent. Requires admin role. Returns 200 on success and 422 on validation error.

```APIDOC
## POST /api/v1/user/create_live_agent

### Description
Creates a new user with role agent.

### Method
POST

### Endpoint
/api/v1/user/create_live_agent

### Required Roles
- admin

### Responses

#### Success Response (200)
Successful Response

#### Validation Error (422)
Validation Error
```
Tokens:
Raw