> ## Documentation Index
> Fetch the complete documentation index at: https://docs.animusai.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Unified AI platform combining text, vision, image generation, and tools in one simple SDK

# Build powerful AI conversations with minimal code

The Animus platform provides state-of-the-art AI models through both a simple JavaScript SDK and REST API. **Skip the complexity of managing multiple AI services** - instead of setting up separate cloud infrastructure for vision models, speech processing, language generation, and image creation, the Animus SDK handles it all for you in minimal code.

## Get Started in Seconds

<CardGroup cols={4}>
  <Card title="Text Generation" icon="message">
    Advanced language models for conversations and content
  </Card>

  <Card title="Vision Analysis" icon="eye">
    Understand and analyze images with AI
  </Card>

  <Card title="Image Generation" icon="image">
    Create stunning visuals from text descriptions
  </Card>

  <Card title="Tool Integration" icon="wrench">
    Connect to external APIs and services
  </Card>
</CardGroup>

**Traditional approach:** Wire up multiple AI providers, manage different APIs, handle authentication and scaling for each service.

**Animus approach:** One SDK, one authentication, unified event system

```javascript theme={null}
// Complete multi-modal AI in 5 lines
import { AnimusClient } from 'animus-client';
const client = new AnimusClient({ tokenProviderUrl: 'your-auth-server' });

// Handle both text and image responses
client.on('messageComplete', (data) => console.log('AI:', data.content));
client.on('imageGenerated', (data) => console.log('Generated image:', data.url));

client.chat.send('Can I see what you\'re doing right now?');
// AI responds with both text description AND generates an image automatically
```

<CardGroup cols={2}>
  <Card title="SDK Quickstart (Recommended)" icon="rocket" href="/sdk-quickstart">
    JavaScript/TypeScript developers - Get started in 30 seconds with minimal code
  </Card>

  <Card title="REST API Quickstart" icon="code" href="/rest-api-quickstart">
    Any programming language - Direct HTTP integration with maximum control
  </Card>
</CardGroup>

## Why Choose the SDK?

<CardGroup cols={3}>
  <Card title="Unified AI Platform" icon="layers">
    All AI modalities (text, vision, image generation, tools) in one SDK - no need to manage multiple providers
  </Card>

  <Card title="Minimal Setup" icon="bolt">
    One npm install, 2 lines of code to access all AI capabilities
  </Card>

  <Card title="Event-Driven Architecture" icon="bullseye">
    Built-in event handling for all modalities with automatic streaming
  </Card>
</CardGroup>

## Core Features

The Animus platform offers powerful capabilities through both SDK and REST API:

* **🧠 Advanced Models**: Access our powerful Vivian and Xavier models optimized for different use cases
* **💬 Chat Completions**: Generate human-like responses for conversations and content creation
* **🎨 Image Generation**: Create stunning images from text descriptions with intelligent detection
* **👁️ Vision Analysis**: Understand and analyze images with our vision capabilities
* **🔄 Real-time Streaming**: Get responses as they're generated for interactive experiences
* **🛠️ Tool Calling**: Integrate external tools and APIs into your AI workflows
* **🔀 AutoTurn Conversations**: Intelligent message splitting for natural conversational flow
* **🛡️ Content Compliance**: Built-in safety checks to ensure appropriate content

## SDK vs REST API Comparison

| Feature              | SDK                            | REST API                        |
| -------------------- | ------------------------------ | ------------------------------- |
| **AI Modalities**    | All modalities unified         | Separate endpoints per modality |
| **Setup Time**       | \< 30 seconds                  | 2-5 minutes per modality        |
| **Code Required**    | 2-3 lines for all features     | 10-20 lines per modality        |
| **Language Support** | JavaScript/TypeScript          | Any language                    |
| **Event Handling**   | Built-in across all modalities | Manual implementation           |
| **Streaming**        | Automatic for all features     | Manual parsing                  |
| **Infrastructure**   | Zero - we handle everything    | Manage multiple AI providers    |

## Popular Use Cases

<CardGroup cols={2}>
  <Card title="Chatbots & Virtual Assistants" icon="robot" href="/sdk-features/chat-conversations">
    Build conversational AI with automatic turn management
  </Card>

  <Card title="Creative Content Generation" icon="palette" href="/sdk-features/image-generation">
    Generate text and images for marketing, social media, and more
  </Card>

  <Card title="Real-time Applications" icon="mobile" href="/sdk-features/streaming-events">
    Create interactive experiences with live streaming responses
  </Card>

  <Card title="Tool Integration" icon="wrench" href="/sdk-features/tool-calling">
    Connect AI to external APIs and services
  </Card>

  <Card title="Advanced Features" icon="sparkles" href="/essentials/advanced-features">
    AutoTurn conversations, image generation, and content compliance
  </Card>
</CardGroup>

## Authentication

To use Animus, you'll need an API key from your [dashboard](https://platform.animusai.co/dashboard).

<Tip>
  The SDK handles authentication automatically once configured. For REST API, include your key in the Authorization header.
</Tip>

## Ready to Get Started?

<CardGroup cols={3}>
  <Card title="Start with SDK" icon="rocket" href="/sdk-quickstart">
    Recommended for the easiest way to start integrating powerful chat apps in your application with minimal code
  </Card>

  <Card title="SDK Configuration" icon="gear" href="/sdk-features/configuration-reference">
    Complete reference for all SDK parameters and configuration options
  </Card>

  <Card title="Choose Your Path" icon="map" href="/choose-your-path">
    Not sure which approach? We'll help you decide
  </Card>
</CardGroup>
