- HubSpot setup guide
- Partner Developer Documentation
- System
- Tenants
- Agents
- Tools
- Calls
- List calls
- Start an outbound call
- Start an outbound call with an ad-hoc agent
- Usage statistics
- Detailed call statistics
- Export all data for a data subject
- Call statistics
- Erase all calls for a data subject
- Get call details
- Erase a single call
- Mark a call completed
- Download a call transcript
- Get a call recording URL
- Get the function/tool execution log
- Repair recording metadata
- Diagnose recording availability
- Phone Numbers
- Statistics
- Subscription
- Web Access
- AI Tools
- Account
- Platform Admin
- Knowledge Base
- Chat Widget
- Get public widget configGET
- Start a chat sessionPOST
- Send a chat messagePOST
- Get chat historyGET
- Poll session statusGET
- Poll session status (POST)POST
- Get full widget configGET
- Update widget configPUT
- Upload chat avatarPOST
- Delete chat avatarDELETE
- List all chat sessionsGET
- Get session with messagesGET
- Close a chat sessionPOST
- Close inactive sessionsPOST
- Get chat statsGET
- Get public widget config
- Version History
- Workflows
- Chat Operator
- Chat Verification
- Tool Logs
- Admin (internal)
- Trigger synthetic error
- List customers without a payment provider
- List all customers with details
- Manually set a customer's plan
- Detailed platform statistics
- List all tenants
- Get tenant details
- Update a tenant
- Purge a tenant
- List all agents
- Edit any agent
- List all calls
- Platform-wide statistics
- Revenue breakdown by month
- Bulk-purchase phone numbers
- List all phone numbers (pool)
- Import owned numbers from telephony connection
- Reset a tenant's monthly usage
- Retrieve a tenant's API key
- List call routing rules
- Sync call routing rules
- List subscription upgrade requests
- Approve a subscription request
- Reject a subscription request
- Update a customer's subscription
- Get a customer's monthly usage history
- Run the retention sweep now
- List deletion certificates
- List resellers
- Create a reseller
- Cross-reseller billing overview
- Update a reseller
- Import a number series into inventory
- List number inventory
- Bulk-allocate a number range to a reseller
- Allocate a single number
- List reseller admins
- Add or invite a reseller admin
- Revoke a reseller admin
- Attach a tenant to a reseller
- Set and attach a reseller domain
- Get reseller domain status
- Sync authentication redirect allow-list
- Get a reseller's billing basis
- Agent builder
- AI assist
- Auth & onboarding
- Billing
- Branding
- Calendar
- Google calendar OAuth callback
- Outlook calendar OAuth callback
- Get Google calendar authorization URL
- Get Outlook calendar authorization URL
- List calendar connections
- Disconnect a calendar
- List calendars within a connection
- Get an agent's calendar configurations
- Attach a calendar to an agent
- Update an agent calendar configuration
- Remove a calendar from an agent
- Check available appointment slots
- List a customer's bookings
- Book an appointment
- Cancel an appointment
- Chat
- Privacy & GDPR
- Identity verification
- List service connections
- Create or update a service connection
- Delete a service connection
- Update test user settings on a connection
- Test a service connection
- Initiate BankID/eID caller verification
- Check BankID/eID verification status
- Check BankID/eID verification status by room
- List all available verification methods
- Initiate Vipps caller verification
- Check Vipps verification status
- Check Vipps verification status by room
- List verification logs
- Get verification statistics
- Anonymize a verification record (GDPR)
- Get verification retention policy
- List marketplace tools
- List an agent's marketplace tools
- Add a marketplace tool to an agent
- Update an agent's tool settings
- Remove a tool from an agent
- Get enabled eID methods for the tenant
- Integrations
- List available integration providers
- List tenant connections
- Create an API-key connection
- Delete (disconnect) a connection
- Get a fresh access token for a connection
- Start an OAuth2 authorization flow
- OAuth2 redirect callback
- List actions for a provider
- List an agent's integrations
- Add an integration to an agent
- Update an agent integration's config
- Remove an integration from an agent
- Execute an integration action during a call
- Dispatch end-of-call integrations
- Invites
- Knowledge base
- Organizations
- Partner
- Phone numbers
- Wholesale
- Reseller
- Get the current reseller
- Update reseller branding and settings
- List resellers the admin belongs to
- Get portal domain and DNS status
- Upload a branding image
- List packages
- Create a package
- Update a package
- Delete a package
- List customers
- Create a customer
- Update a customer
- Permanently delete a customer
- List a customer's members and invites
- Invite a user into a customer org
- Revoke a pending invite
- Remove a member from a customer org
- Get act-on-behalf access for a customer
- Portfolio usage and billing for a month
- Portfolio call analytics for a month
- Top conversation topics for a month
- List the number pool
- Add a number to the pool
- Assign or release a number
- Remove a number from the pool
- List reseller staff
- Add a reseller staff member
- Change a staff member's role
- Remove a staff member
- List a customer's topups for a month
- Add a topup on a customer's behalf
- Export billing basis as CSV
- List email templates
- Override an email template
- Send a test email template
- Preview an email template
- Upload an email image asset
- Count newsletter recipients
- List past newsletters
- Send a newsletter
- Preview a newsletter
- List deletion certificates
- Export a data subject for a customer
- Erase a data subject for a customer
- Get sending domain status
- Register a sending domain
- Remove the sending domain
- Re-verify sending domain DNS
- Send a test email from the sending domain
- List integration OAuth providers
- Set integration OAuth credentials
- Remove integration OAuth credentials
- Reseller
- Support
- Tool logs
- Top-ups
- Users
- Web access
- Webhooks
- End-of-call webhooks
- Schemas
Start a chat session
POST
/api/chat/session
Request
Authorization
API Key
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************or
Body Params application/jsonRequired
Examples
Responses
🟢200
application/json
Bodyapplication/json
🟠400
🟠403
🟠404
🟠429
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.snakk.ai/api/chat/session' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"visitor_id": "string",
"referrer_url": "string",
"page_url": "string",
"user_agent": "string"
}'Response Response Example
{
"session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82"
}Modified at 2026-07-08 19:01:40