External API for Agents
Welcome to the Amica API Documentation. Amica is a powerful 3D VRM (Virtual Reality Model) agent interface and hub that allows users to connect with external web services and agent AI frameworks, enabling seamless remote control and puppetry of the VRM characters. With Amica, you can create interactive agents that serve as dynamic 3D character interfaces for AI agents, applications and users.
The Amica API provides a set of flexible and robust routes for interacting with Amica’s system, including functions like real-time client connections, memory retrieval, system updates, social media integration, and more. These capabilities enable you to build custom logic, including reasoning, tool use (such as EACC Marketplace functions) and memory management, on external servers.
Whether you're using Amica to handle real-time interactions or to trigger complex actions based on user input, this documentation will guide you through the supported API routes, input types, and examples. Use Amica’s APIs to bring your 3D agents to life with rich functionality and integration.
This documentation will help you get started with the following key features:
Real-Time Interaction: Establish and manage connections through Server-Sent Events (SSE).
Memory Management: Store and retrieve subconscious prompts or custom data.
Custom Logic & Reasoning: Trigger actions like animations, playback, and social media posts.
Voice and Image Processing: Leverage transcription and image-to-text capabilities.
Data Handling: Retrieve and update server-side data via simple file-based operations. (Coming soon)
Dive in and start integrating Amica’s capabilities into your applications!
Setting up Amica's External API
To use the External API, you MUST set up running Amica locally on your own computer or server. This also ensures localized database design is kept for people hosting their own Amicas.
Once it is running locally, all the api routes can be called directly to the Amica server.
Route: /api/amicaHandler
/api/amicaHandlerThis API route handles multiple types of requests, including social media integration, system prompt updates, memory requests, and real-time client connections via Server-Sent Events (SSE). It ensures robust logging and provides error handling for incoming requests.
Supported HTTP Methods:
GET: Establishes an SSE connection.
POST: Processes various input types based on the
inputTypeprovided in the request body.
Input Types
1. Normal Chat Message: Retrieve normal chat response from Amica LLM without make avatar speaking.
Example Usage: Use the Amica's paired LLM for conversation retrieval without making the avatar speak.
JSON Input Example
JSON Output Example
2. Memory Request: Fetches memory data (Subconscious stored prompt).
Example Usage: Fetch Amica's subconcious thoughts from the user's conversations.
JSON Input Example
JSON Output Example
3. RPC Logs: Fetches logs.
Example Usage: Build a interface that logs what Amica is doing.
JSON Input Example
JSON Output Example
4. RPC User Input Messages: Fetches user input messages.
Example Usage: Retrieve the user's input and run it through a separate agentic framework.
JSON Input Example
JSON Output Example
5. Update System Prompt: Updates the system prompt.
Example Usage: Use this to change Amica's system prompt based on external reasoning server
JSON Input Example
JSON Output Example
6. Brain Message: Adding new memory data (Subconscious stored prompt).
Example Usage: Add new subconcious memories from external framework.
JSON Input Example
JSON Output Example
7. Chat History: Fetches chat history.
Example Usage: Track the user's conversation history with Amica and process it.
JSON Input Example
JSON Output Example
8. Remote Actions: Triggers actions like playback, animation, socialMedia and reprocess.
Example Usage: Trigger animations based on a external event such as news.
The Reasoning Server allows you to execute various actions based on the provided payload. Below are the supported properties and their accepted values:
text: A string message or
null.socialMedia: Options include
"twitter","tg", or"none".playback: A boolean value (
trueorfalse).animation: A string specifying the animation file name (
file_name.vrma) ornull.reprocess: A boolean value (
trueorfalse).
JSON Input Example
JSON Output Example
Route: /api/mediaHandler
/api/mediaHandlerThis API route handles voice and image inputs, leveraging multiple backends for processing, such as transcription with Whisper OpenAI/WhisperCPP and image-to-text processing using Vision LLM. It ensures robust error handling, session logging, and efficient processing for each request.
Example Usage: Directly use the configured STT and Vision LLM backends to process voice and image inputs, without building a new one.
Supported HTTP Methods:
POST: Processes voice and image inputs based on the
inputTypeandpayloadprovided in the request.
Input Types
1. Voice: Converts audio input to text using specified STT (Speech-to-Text) backends.
2. Image: Processes an image file to extract text using Vision LLM.
Form-Data Input Example
inputType
Text
Specifies the type of input (Voice or Image).
payload
File
The file to be processed (e.g., audio or image).
Curl Input Example
JSON Output Example
Error Handling
Validates essential fields (
inputType,payload).Logs errors with timestamps and session IDs.
Returns appropriate HTTP status codes (e.g., 400 for bad requests, 503 for disabled API).
Logging
Logs each request with:
sessionIdtimestampoutputTyperesponseorerror
Notes
Ensure environment variable
API_ENABLEDis set totruefor the API to function.The SSE connection remains active until the client disconnects.
Route: /api/dataHandler
/api/dataHandlerThis API route is used to retrieve and update client-side information through server-side operations. Since the application cannot directly update or retrieve data from the server side, these operations involve writing and reading data from static files that are continuously updated.
The primary purpose of this route is to utilize the data written to files for operations performed in the /api/mediaHandler and /api/amicaHandler routes.
File Paths
config.jsonPath:
src/features/externalAPI/dataHandlerStorage/config.jsonDescription: Contains the configuration data used throughout the application. This file is read and updated dynamically by the API.
subconscious.jsonPath:
src/features/externalAPI/dataHandlerStorage/subconscious.jsonDescription: Stores data related to subconscious operations. It is cleared on startup and updated via the API.
logs.jsonPath:
src/features/externalAPI/dataHandlerStorage/logs.jsonDescription: Keeps track of log entries, including types, timestamps, and arguments. The data is cleared on startup and updated via the API.
userInputMessages.jsonPath:
src/features/externalAPI/dataHandlerStorage/userInputMessages.jsonDescription: Maintains user input messages for chat functionalities. Data is cleared on startup and appended to this file through the API.
chatLogs.jsonPath:
src/features/externalAPI/dataHandlerStorage/chatLogs.jsonDescription: Stored user chat history. Data is cleared on startup and appended to this file through the API.
Features
Retrieve data: Supports fetching configurations, subconscious data, logs, user input messages and chat history.
Update data: Enables modifications to configurations, subconscious data, logs, user input messages and chat history.
GET
Retrieve specific data from the server.
Query Parameters:
type(required): Specifies the type of data to retrieve. Accepted values:config,subconscious,logs,userInputMessages,chatLogs.
Example Request:
POST
Update data on the server.
Query Parameters:
type(required): Specifies the type of data to update. Accepted values:config,subconscious,logs,userInputMessages,chatLogs.
Example Request:
Last updated