Core API Reference

Access Convai's core API reference documentation to enhance your AI character development.

Dive into the specifics of each API endpoint by checking out our complete documentation. The section is divided into all the services provided by Convai to it's developers.

Heads Up

Misuse of this API, for unethical or malicious activities is highly condemned and will trigger an automatic ban of the account, and the associated API key will be blacklisted from access.

While using the API, if a response with "Status code 500" is received, the user can contact Convai at [e-mail] with the "Reference ID" returned in the response to help in debugging.

For additional resources, you can also explore our Python Notebook.

This notebook is a hands-on guide to using Convai’s Core APIs for creating responsive NPCs. It walks you through setting up a character, defining its narrative and backstory, and integrating voice capabilities effectively.

If you encounter any issues or have questions, please don’t hesitate to reach out to us through our Convai Developer Forum.

Core APIs

All APIs related to creating and deploying your first smart NPC or Digital Assistant.

Character Base APIInteraction APICore AI Setting APIBackstory APIChat History APIKnowledge Bank APINarrative Design APIAction API

Language List API

Voice List API

Evaluation API