API Reference

Build on BlueSales. Manage Blues, business profiles, brains, leads, and more — all programmatically.

Base URLhttps://api-v2.bluesales.ai/functions/v1

Authentication

All requests require an X-API-Key header. Generate keys in Dashboard → API.

GET https://api-v2.bluesales.ai/functions/v1/api/blues
X-API-Key: bsk_your_api_key_here

Keep your key secret. Never expose it in client-side code. Each key has scoped permissions and rate limits.

Permissions

Each key has a set of permissions. Attempting an action without the required permission returns 403 Forbidden.

blues:read
blues:write
blues:delete
business_profiles:read
business_profiles:write
business_profiles:delete
brains:read
brains:write
brains:delete
products_services:read
products_services:write
products_services:delete
lead_lists:read
lead_lists:write
lead_lists:delete
leads:read
leads:write
leads:delete
phone_numbers:read
phone_numbers:write
calendar:read
calendar:write
calls:read
calls:write
compliance:read
compliance:write

Blues

Blues are your AI voice agents. You can create them entirely via API, including creating their business profile, brain, and other resources in a single request using inline objects.

Business Profiles

Brains

Knowledge bases for your Blues. Text and website brains can be created via API. File-based brains require the dashboard.

Products & Services

Lead Lists

Leads

Phone Numbers

Import phone numbers from your own Twilio account or read existing ones.

Calendar

Supports Google Calendar, Microsoft Outlook, and a webhook (bring-your-own-calendar) mode for white-label setups where you hold your users' tokens yourself.

Calls

Trigger immediate outbound calls and retrieve call history programmatically.

Errors

All errors return JSON with an error string.

{ "error": "Missing permission: blues:write" }
StatusMeaning
200OK
201Created
400Bad Request — missing or invalid fields
401Unauthorized — invalid or missing API key
403Forbidden — API key lacks required permission
404Not Found
405Method Not Allowed
500Server Error

Need help? Open your API dashboard to manage keys and view request logs.

We use cookies to analyze site traffic and improve your experience. Privacy Policy