IntegrationsWeb API
API Reference
Explore the available endpoints for the Neocortex Web API
The Neocortex Web API provides a set of HTTP endpoints that allow you to interact with Smart NPCs programmatically. This reference covers all available endpoints, including chat, session history, text-to-speech, and speech-to-text.
Endpoints
Method | URL | Description |
---|---|---|
POST | /api/v2/chat | Send a chat message to a character and receive it's reply. |
POST | /api/v2/chat/session | Request message history of a chat session. |
POST | /api/v2/audio/generate | Generate speech of a character. |
POST | /api/v2/audio/transcribe | Transcribe audio into text. |
Using your API Key
With each request do not forget to send your API Key with x-api-key
header.
Chat with a character
Sends a message to a Smart NPC and receives a response.
Get past messages
Retrieves past chat sessions and messages for a specific character.
Generate speech
Generates speech from a text input using the character's configured voice.
Binary audio data
Transcribe audio
Key | Value |
---|---|
audio | audio_file.wav |
characterId | cmdivwjpz00357kngoxn0b97t |