External API for Agents
Last updated
Last updated
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 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!
To use the External API, you MUST set up 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.
/api/amicaHandler
This 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.
GET: Establishes an SSE connection.
POST: Processes various input types based on the inputType
provided in the request body.
Example Usage: Use the Amica's paired LLM for conversation retrieval without making the avatar speak.
Example Usage: Fetch Amica's subconcious thoughts from the user's conversations.
Example Usage: Build a interface that logs what Amica is doing.
Example Usage: Retrieve the user's input and run it through a separate agentic framework.
Example Usage: Use this to change Amica's system prompt based on external reasoning server
Example Usage: Add new subconcious memories from external framework.
Example Usage: Track the user's conversation history with Amica and process it.
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 (true
or false
).
animation: A string specifying the animation file name (file_name.vrma
) or null
.
reprocess: A boolean value (true
or false
).
/api/mediaHandler
This 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.
POST: Processes voice and image inputs based on the inputType
and payload
provided in the request.
inputType
Text
Specifies the type of input (Voice
or Image
).
payload
File
The file to be processed (e.g., audio or image).
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).
Logs each request with:
sessionId
timestamp
outputType
response
or error
Ensure environment variable API_ENABLED
is set to true
for the API to function.
The SSE connection remains active until the client disconnects.
/api/dataHandler
This 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.
config.json
Path: src/features/externalAPI/dataHandlerStorage/config.json
Description: Contains the configuration data used throughout the application. This file is read and updated dynamically by the API.
subconscious.json
Path: src/features/externalAPI/dataHandlerStorage/subconscious.json
Description: Stores data related to subconscious operations. It is cleared on startup and updated via the API.
logs.json
Path: src/features/externalAPI/dataHandlerStorage/logs.json
Description: Keeps track of log entries, including types, timestamps, and arguments. The data is cleared on startup and updated via the API.
userInputMessages.json
Path: src/features/externalAPI/dataHandlerStorage/userInputMessages.json
Description: Maintains user input messages for chat functionalities. Data is cleared on startup and appended to this file through the API.
chatLogs.json
Path: src/features/externalAPI/dataHandlerStorage/chatLogs.json
Description: Stored user chat history. Data is cleared on startup and appended to this file through the API.
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.
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:
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: