Web API
Call characters from any engine
The Neocortex Web API lets any engine, language or platform talk to the characters you build in the editor over plain HTTP. Everything the Neocortex SDKs do goes through the same endpoints, so a custom engine, a game server or a backend tool gets exactly the same characters as an SDK project. Send a character id and the player's message, and the reply comes back as structured data your game can act on.
Web API Features
The Web API is the route for engines without an SDK, for servers, and for anything else that can make an HTTPS request.
Three Key Features & Benefits
One base URL serves chat, group chat, conversation history, text-to-speech, streamed speech and speech-to-text, authenticated with an API key that is scoped to your team. Other advantages include:
Replies are structured data, not a block of prose: one to three lines each tagged with an emotion, the in-game actions the character chose with the id of the object each one targets, and the Conversation Flow checkpoint the turn reached.
Your game can tell a character what it perceives and what just happened, with up to 40 entities and 20 events per request. World data is always treated as data, never as instructions.
A usage endpoint reports usage per player and per character against the caps you set in the dashboard, so your game can tell when a player is over a limit before it calls.
For browser games, the Web SDK adds a small server proxy that keeps your API key on your server, so the browser never sees it.