Copy Page
Snakk AI - Voice Agent Platform API
HubSpot setup guide
Partner Developer Documentation
System
Simple health check
GET
Detailed health check with dependency status
GET
Tenants
Create a new account
POST
Agents
List agents
Create agent
Get agent
Update agent
Delete agent
Duplicate agent
Activate or deactivate agent
Tools
List tools/webhooks for agent
List tools
Add tool/webhook to agent
Create tool
Update tool
Delete tool
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
List your phone numbers
List numbers in the platform pool
Assign number to agent
Claim a number from the pool
Unassign number from agent
Release a number back to the pool
Statistics
Get dashboard overview statistics
Get daily call breakdown
Get monthly usage breakdown
Get per-agent statistics
Sync stored recordings to calls
List orphaned recordings
List call recordings
Subscription
Get current subscription and usage
List available subscription plans
Upgrade subscription (deprecated)
Web Access
Create a web voice session token
AI Tools
Generate an agent prompt from a description
Account
Get current account
Update current account
Regenerate API key
Check platform-admin status by email
Platform Admin
Platform-wide overview (legacy)
Knowledge Base
List knowledge base files
Upload document to knowledge base
Delete knowledge base file
Chat Widget
Get public widget config
Start a chat session
Send a chat message
Get chat history
Poll session status
Poll session status (POST)
Get full widget config
Update widget config
Upload chat avatar
Delete chat avatar
List all chat sessions
Get session with messages
Close a chat session
Close inactive sessions
Get chat stats
Version History
List agent versions
Get a specific agent version
Compare two agent versions
Restore an agent to a version
Workflows
List workflows
Create workflow
Get workflow
Update workflow
Delete workflow
Publish workflow version
List workflow versions
Roll back workflow to a previous version
Assign workflow to an agent
Unassign workflow from an agent
Chat Operator
Create a contact request
Get operator queue
Get operator's active chats
Claim a chat
Release a chat
Send message as operator
Update operator status
Operator real-time events
Get session messages (operator)
Update session customer info
List contact requests
Update a contact request
Get operator statistics
Chat Verification
Get chat verification status
Initiate chat verification
Check if verification is required
Tool Logs
List tool call logs
Tool usage statistics
Get a single tool call log
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
Store a generated agent configuration
Retrieve a stored agent configuration
Mark a configuration as claimed
AI assist
Refine an existing agent prompt
Crawl a website and generate an agent prompt
Generate an agent via the guided wizard
Crawl a website and extract structured business data
Generate a comprehensive agent from detailed inputs
Auth & onboarding
Lazily migrate a legacy password
Sign up a new user
Log in
Refresh session
Current user
Log out
Request password reset
Update password
Billing
List subscription plans
Create a checkout session
Create a billing portal session
Get current subscription and usage
Create a payment link (admin)
Create a custom invoice (admin)
Branding
Resolve white-label branding for a host
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
List sessions for an agent
Get operator status
Privacy & GDPR
List deletion certificates
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
Get invitation details
Accept an invitation
Knowledge base
List knowledge base files for an agent
Upload a knowledge base file for an agent
Delete a knowledge base file
Organizations
List my organizations
Create an organization
Delete an organization
List organization members
Remove a member
Invite a member
List pending invites
Revoke a pending invite
Remove a pending member
Partner
Submit a new integration
List my integrations
Update an integration
Get integration stats
Review and approve or reject an integration
List pending reviews
Phone numbers
List all pool numbers with summary
Search numbers available to purchase
Purchase a phone number
Assign a number to an agent
Unassign a number from its agent
Release a number from your account
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
Support
Look up a customer by email
List a customer's agents
Get a customer's current-month usage
Get full agent detail
Tool logs
Create a tool call log
Top-ups
Get this month's minute balance
List available top-up packages
Order a top-up package
Users
List team members
Invite team member
Update user role
Remove team member
Web access
Get agent avatar preview info
Webhooks
Agent call-ended notification
Look up agent by phone number
Log a tool call from the agent
End-of-call webhooks
List end-of-call webhooks
Create end-of-call webhook
Update end-of-call webhook
Delete end-of-call webhook
Schemas
Tenant
Error
Agent
AgentCreate
ToolLog
AgentUpdate
Call
AgentTool
Tool
CreateToolRequest
UpdateToolRequest
EndOfCallWebhook
CreateEndOfCallWebhookRequest
UpdateEndOfCallWebhookRequest
Workflow
WorkflowDefinition
KnowledgeBaseFile
ToolCallLog
AgentCalendar
ResellerBranding
ResellerModules
WholesalePriceTiers
UpdateToolRequest
Copy Page
Fields to update a tool (all optional).
{
"property1"
:
"string"
,
"property2"
:
"string"
}