Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

description Explore Convai’s Core APIs, divided into Character Crafting and Interaction APIs, to create, customize, and interact with intelligent AI characters.

Core API Reference

This section provides a detailed overview of Convai’s Core APIs, which serve as the foundation for building intelligent and interactive virtual characters. The Core APIs are divided into two main categories: Character Crafting APIs and Interaction APIs, each serving a distinct purpose in your development workflow.

{% embed url="https://youtu.be/vwBzaQP0Bl4?si=tQ5LGv-F9nxwxv1u" %}

Understanding the Core API

Convai’s Core API empowers developers to create, customize, and deploy AI-driven characters across various use cases — from immersive games to virtual assistants.

The Core API is structured into two segments:

{% content-ref url="character-crafting-apis/" %} character-crafting-apis {% endcontent-ref %}

{% content-ref url="interaction-apis/" %} interaction-apis {% endcontent-ref %}


{% hint style="danger" %} Heads Up

Misuse of this API for unethical or malicious purposes will result in an automatic ban of the associated account and API key. {% endhint %}

{% hint style="info" %} 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. {% endhint %}

{% hint style="success" %} If you encounter any issues or have questions, please don’t hesitate to reach out to us through our Convai Developer Forum. {% endhint %}