> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/api-reference/core-api-reference.md).

# Core API Reference

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

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="/pages/gsTUYbL4ZFKCtOINokQj" %}
[Character Crafting APIs](/api-docs/api-reference/core-api-reference/character-crafting-apis.md)
{% endcontent-ref %}

{% content-ref url="/pages/hIPRKZO2HDe3YYFi3g7J" %}
[Interaction APIs](/api-docs/api-reference/core-api-reference/interaction-apis.md)
{% 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](https://colab.research.google.com/drive/17Bazf92ZsXQmJZ91CbVAhiPmnapIuTgS?usp=sharing).

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](https://forum.convai.com).
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.convai.com/api-docs/api-reference/core-api-reference.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.