For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quick Start

Welcome to the official Cuoral Developer Documentation! Here you’ll find everything you need to start integrating with the Cuoral platform to deliver proactive, AI-powered customer experiences at scale.

Cuoral helps businesses reduce silent churn, resolve issues before users complain, and drive continuous product improvement - all through intelligent engagement workflows across chat, email, and SMS.


What You Can Do With the Cuoral API

  • Create and manage customer companies and contacts

  • Trigger automated engagement workflows

  • Fetch customer feedback and issue logs

  • Analyze product experience trends in real-time

  • Integrate Cuoral into your internal tools or customer systems

Whether you're building a custom support dashboard, syncing user data, or triggering proactive messaging - our APIs are designed to be simple, fast, and powerful.


🔑 Get Your API Key

To use the Cuoral API, you’ll need an API Key scoped to your organization Sign up here to get your API key Once signed in, head to the Settings → API Access section to generate and manage your keys.

Your API key must be included in the x-api-key header for all requests:

x-api-key: YOUR_API_KEY

What’s Next?

  • Start with the Company API to create and manage customer organizations

  • Explore Contact APIs for individual users

  • Engagement APIs for customer outreach

  • Use Workflow APIs to automate messaging and feedback collection

Need help? Reach out to our team anytime at team@cuoral.com

Happy Building! 💡

Want to deep dive?

Dive a little deeper and start exploring our API reference to get an idea of everything that's possible with the API:

Customers

Last updated