🚀 The Shilo API is Live! 🚀
The wait is over — the Shilo API is now available to every account! 🎉 Connect your calls, contacts, appointments, role plays, and account-wide metrics directly into your own internal systems. ⚙️
Ever wished you could pull your Shilo data straight into your own dashboards, CRM, or reporting tools? 🧐 Now you can. The API gives you secure, direct access to your account data so you can build Shilo into your workflows any way you like. 🌟
✅ Generate and manage your own API keys 🔑
✅ Pull contacts, calls, appointments, role plays, and big-picture metrics 📊
✅ Start safely with read-only access for reporting 🛡️
✅ Monitor usage and errors from a built-in dashboard 📈
✅ Request higher rate limits in a click ⚡️
Dive in, build something great, and let us know what you think! 🙌
🍿 Video Walkthrough! 👇
🛠 API Setup Guide
Here's everything you need to start using the Shilo API.
Step 1: Make Sure You Have Access
API access is available to Owner and Admin accounts only.
Individual users cannot generate an API key or access data via the API.
Step 2: Open the API Keys Settings
Click the Settings cog.
Select the API Keys tab — it's the last tab on the right-hand side.
Step 3: Generate Your API Key
Click Generate API Key.
Give your key any name you'd like.
Choose whether to make it read-only.
💡 Our recommendation: When you're just getting started — especially for reporting — create your key as read-only. This limits access to GET endpoints only, so there's no chance of anything unintended happening on a POST endpoint.
After you generate the key, copy it right away. You'll only see it once — after that it disappears forever. 🔒
Step 4: Manage Your Keys
Once a key is live, you have a few options:
Revoke any key to immediately cut off its access.
See who created each key, its name, and its prefix — so you can always tell which key is which.
Step 5: Raise Your Rate Limits (If Needed)
Click the radio button next to a key to open the rate-limit options at the bottom.
Click Request Upgrade to automatically raise that key's rate limit.
Still hitting your limit after upgrading? Email us and we'll address it on a case-by-case basis. 📩
Step 6: Monitor Usage on the Dashboard
The built-in dashboard shows you:
Client-side errors
Server-side errors
Successful requests
Keep an eye on your API health in real time. 📊
Step 7: Explore the API Docs
Click the API Docs button to open the full documentation. Or use this link: https://api.shilo.ai/api/v1/docs
From the API you can:
Get user data
Send invitations
Pull contact-specific information
Pull call-specific information
Access appointments
Access role plays
Grab larger account-wide metrics
This makes it easy to build Shilo into your own internal systems however you need. 🔗
More to Come 👀
This is just the beginning — we have some fun surprises lined up to fast-follow this API release. Stay tuned!
Have Feedback?
We're always looking to make things better. Run into an issue or have an idea? Let us know — we're all ears! 📝✨
❓ Frequently Asked Questions
Who can create an API key? API access is limited to Owner and Admin accounts. Individual users can't generate a key or access data through the API.
Where do I find the API settings? Click the Settings cog, then open the API Keys tab — it's the last tab on the right-hand side.
How do I create a key? Click Generate API Key, give it any name you'd like, and choose whether to make it read-only. Then copy the key right away.
Should I make my key read-only? We recommend it when you're starting out, especially for reporting. Read-only limits access to GET endpoints, so there's no chance of anything unintended happening on a POST endpoint.
I didn't copy my key — can I see it again? No. Your key is shown only once at the moment you generate it, then it disappears forever. If you've lost it, just generate a new one.
How do I turn off a key? Click Revoke next to the key. Access is cut off immediately.
How do I tell my keys apart? For each key you can see who created it, its name, and its prefix — so you can always figure out which key is which.
What if I hit my rate limit? Click the radio button next to the key and select Request Upgrade to automatically raise that key's rate limit. If you keep hitting your limit after that, email us and we'll address it on a case-by-case basis.
How do I monitor my usage? The built-in dashboard shows your client-side errors, server-side errors, and successful requests in real time.
What data can I access through the API? You can get user data, send invitations, and pull contact, call, appointment, and role play information — plus larger account-wide metrics. Full details are in the API Docs (click the API Docs button).
What can I build with it? The API is designed to help you integrate Shilo into your own internal systems — dashboards, CRMs, reporting tools, and more.
I have a question that isn't covered here. Reach out any time — we're always happy to help and we love your feedback! 📝