# Animus AI Documentation

## Docs

- [Conversational Turns](https://docs.animusai.co/advanced-sdk/auto-turn-conversations.md): Create natural conversation flow with AutoTurn - automatically split long responses into multiple messages with realistic typing delays. Mimic human communication patterns to make AI interactions feel genuinely engaging.
- [Event System](https://docs.animusai.co/advanced-sdk/event-system.md): Build responsive, interactive applications with comprehensive event-driven architecture. Real-time feedback for all operations gives you precise control over the user experience.
- [Tool Calling](https://docs.animusai.co/advanced-sdk/tool-calling.md): Enable AI models to invoke custom functions and interact with external APIs through powerful function calling capabilities. Build sophisticated applications that perform actions, retrieve data, and integrate with existing systems.
- [Approve dataset](https://docs.animusai.co/api-reference/character-dataset/approve-dataset.md)
- [Approve or reject dataset image](https://docs.animusai.co/api-reference/character-dataset/approve-or-reject-dataset-image.md)
- [Delete dataset image](https://docs.animusai.co/api-reference/character-dataset/delete-dataset-image.md)
- [Generate training dataset](https://docs.animusai.co/api-reference/character-dataset/generate-training-dataset.md)
- [Get dataset status](https://docs.animusai.co/api-reference/character-dataset/get-dataset-status.md)
- [List dataset images](https://docs.animusai.co/api-reference/character-dataset/list-dataset-images.md)
- [Regenerate dataset image](https://docs.animusai.co/api-reference/character-dataset/regenerate-dataset-image.md)
- [Cancel training job](https://docs.animusai.co/api-reference/character-training/cancel-training-job.md)
- [Get complete training status](https://docs.animusai.co/api-reference/character-training/get-complete-training-status.md)
- [Get training logs](https://docs.animusai.co/api-reference/character-training/get-training-logs.md)
- [Get training status](https://docs.animusai.co/api-reference/character-training/get-training-status.md)
- [List training jobs](https://docs.animusai.co/api-reference/character-training/list-training-jobs.md)
- [Start body LoRA training](https://docs.animusai.co/api-reference/character-training/start-body-lora-training.md)
- [Start face LoRA training](https://docs.animusai.co/api-reference/character-training/start-face-lora-training.md)
- [Upload body image](https://docs.animusai.co/api-reference/character-upload/upload-body-image.md)
- [Upload face image](https://docs.animusai.co/api-reference/character-upload/upload-face-image.md)
- [Auto-generate face dataset](https://docs.animusai.co/api-reference/character/auto-generate-face-dataset.md)
- [Create character](https://docs.animusai.co/api-reference/character/create-character.md)
- [Delete character](https://docs.animusai.co/api-reference/character/delete-character.md)
- [Get character](https://docs.animusai.co/api-reference/character/get-character.md)
- [List character assets](https://docs.animusai.co/api-reference/character/list-character-assets.md)
- [List characters](https://docs.animusai.co/api-reference/character/list-characters.md)
- [Update character](https://docs.animusai.co/api-reference/character/update-character.md)
- [Chat Completion](https://docs.animusai.co/api-reference/chat/chat-completion.md): Receives a series of messages as input to generate a contextually relevant chat response using a large language model (LLM).
- [Check generation status](https://docs.animusai.co/api-reference/generation/check-generation-status.md): Retrieve progress and results for a submitted generation.
- [Create a batch generation job](https://docs.animusai.co/api-reference/generation/create-a-batch-generation-job.md): Submit multiple prompts at once for character renders or photo edits.
- [Create media generation job](https://docs.animusai.co/api-reference/generation/create-media-generation-job.md): Submit a prompt to generate a character image, photo edit, or image-to-video clip.
- [Delete a generation](https://docs.animusai.co/api-reference/generation/delete-a-generation.md): Remove a generation record and its associated media.
- [Delete a generation group](https://docs.animusai.co/api-reference/generation/delete-a-generation-group.md): Remove a group and purge all related generations and assets.
- [Get generation capabilities](https://docs.animusai.co/api-reference/generation/get-generation-capabilities.md)
- [Get generation group detail](https://docs.animusai.co/api-reference/generation/get-generation-group-detail.md): Fetch generations and metadata for a specific group.
- [List generation groups](https://docs.animusai.co/api-reference/generation/list-generation-groups.md): Return paginated media groups for the authenticated organization.
- [Generate Image ⚠️](https://docs.animusai.co/api-reference/image-generation/generate-image-⚠️.md): ⚠️ **ALPHA FEATURE:** Generates an image from a text prompt using an image generation model. This endpoint is in alpha state and not recommended for production use. The API and functionality may change without notice.
- [Categorize Media](https://docs.animusai.co/api-reference/vision/categorize-media.md): Analyzes an image and returns various metadata categories
- [Get Categorize Status](https://docs.animusai.co/api-reference/vision/get-categorize-status.md): Retrieves the status and results of a video categorization job.
- [Media Completion](https://docs.animusai.co/api-reference/vision/media-completion.md): Generates a response based on provided images and text using a vision-language model.
- [Authentication Setup](https://docs.animusai.co/authentication.md): Protect your API keys with a secure token provider pattern that keeps credentials safely on your backend server. Seamless authentication for frontend applications without compromising security.
- [Choose Your Path](https://docs.animusai.co/choose-your-path.md): Not sure whether to use the Animus SDK or REST API? This guide will help you choose the best approach based on your project requirements, technical constraints, and development preferences.
- [Overview](https://docs.animusai.co/models/overview.md): The Animus API is powered by a diverse set of models with different capabilities and price points. This page provides an overview of our available models.
- [Vivian](https://docs.animusai.co/models/vivian.md): Vivian (vivian-llama3.1-70b-1.0-fp8) is our 70B parameter model based on Llama 3.1. It's specifically designed for natural conversation and relationship building, making it ideal for chatbots, virtual assistants, and other applications requiring engaging dialog.
- [Xavier](https://docs.animusai.co/models/xavier.md): Xavier (xavier-r1) is our specialized 70B parameter reasoning model built on top of Llama 3.1. It excels at emotional reasoning and complex problem-solving, making it ideal for applications requiring nuanced understanding and thoughtful analysis. This model is currently under limited release.
- [Overview](https://docs.animusai.co/overview.md): Unified AI platform combining text, vision, image generation, and tools in one simple SDK
- [Character Training](https://docs.animusai.co/rest-api-integration/character-training.md): Walk through the full pipeline for preparing LoRA models before you trigger generations.
- [Image Generation](https://docs.animusai.co/rest-api-integration/image-generation.md): Generate character images, edit photos, and create videos with the Animus media generation API
- [Moderation](https://docs.animusai.co/rest-api-integration/moderation.md): Identify potentially harmful content in text and images using the REST API
- [Text Generation](https://docs.animusai.co/rest-api-integration/text-generation.md): Learn how to generate text with Animus models using the REST API
- [Vision](https://docs.animusai.co/rest-api-integration/vision.md): Learn how to use vision capabilities to understand images and videos with the REST API
- [Webhooks](https://docs.animusai.co/rest-api-integration/webhooks.md): Webhooks are a way to consume events from Animus in real-time. They allow your application to receive notifications when certain events happen, such as when video processing jobs complete. This is particularly useful for long-running operations where you don't want to continuously poll for status up…
- [REST API Quickstart](https://docs.animusai.co/rest-api-quickstart.md): Get started with the Animus REST API in minutes. Learn how to authenticate and make your first API call.
- [Chat Completions](https://docs.animusai.co/sdk-features/chat-completions.md): Build powerful conversational AI applications with comprehensive chat completion capabilities. Automatic authentication, conversation history management, and flexible interaction methods make integration seamless.
- [SDK Configuration Reference](https://docs.animusai.co/sdk-features/configuration-reference.md): Complete reference for all AnimusClient configuration options, parameters, and default values. Configure chat, vision, authentication, and advanced features.
- [Image generation](https://docs.animusai.co/sdk-features/image-generation.md)
- [Media & Vision](https://docs.animusai.co/sdk-features/media-vision.md): Analyze images and videos, ask questions about visual content, and extract detailed metadata with comprehensive media analysis capabilities. Build applications with powerful computer vision features.
- [Content Moderation](https://docs.animusai.co/sdk-features/moderation.md): Detect potentially harmful content with built-in compliance checking and handle violations according to your application needs
- [Streaming Responses](https://docs.animusai.co/sdk-features/streaming-responses.md): Display AI responses in real-time as they generate with powerful streaming capabilities. Create engaging, responsive user experiences that feel immediate and interactive.
- [SDK Quickstart](https://docs.animusai.co/sdk-quickstart.md): Get up and running with the Animus SDK in under 2 minutes. The animus-client SDK provides the simplest way to integrate powerful AI capabilities into your JavaScript or TypeScript browser applications.

## OpenAPI Specs

- [openapi](https://docs.animusai.co/api-reference/openapi.json)