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

# Overview

> How to integrate Equos into your own application—backend, web, and native.

Integrating Equos into your application is a three-layer story:

<CardGroup cols={3}>
  <Card icon="server" title="1. Backend" href="/integration/backend">
    Your server uses the Equos SDK to create characters, knowledge bases, and—most importantly—**conversations**. It holds your API key; clients never do.
  </Card>

  <Card icon="browser" title="2. Web client" href="/integration/web">
    Your frontend takes the response from a conversation creation and connects to the live room. Use **@equos/browser-sdk** (vanilla) or **@equos/react** (React/Next.js).
  </Card>

  <Card icon="mobile" title="3. Native client" href="/integration/native">
    For iOS or Android, use the official **LiveKit** SDKs with the `consumerAccessToken` and `serverUrl` returned by your backend.
  </Card>
</CardGroup>

## The flow

1. Your backend calls `startConversation` with a `characterId` and a consumer identity. Equos spins up a live room and returns:
   * `conversation.serverUrl` — the LiveKit WebSocket URL for the room
   * `consumerAccessToken` — a short-lived JWT the end user uses to join
   * `conversation.character.livekitIdentity` — the identity the character publishes as
2. You forward those fields to your client (web or native).
3. The client connects to the room and starts talking to the character.

<Warning>
  Your **API key** lives on the server only. The client should only ever receive the `conversation` object and the `consumerAccessToken`.
</Warning>

## Working examples

The [equos-examples](https://github.com/EquosAI/equos-examples) repo contains complete, runnable apps for every layer:

<CardGroup cols={2}>
  <Card icon="github" title="Node.js backend" href="https://github.com/EquosAI/equos-examples/tree/main/examples/equos-nodejs-integration">
    Full backend project with `@equos/node-sdk`.
  </Card>

  <Card icon="github" title="Python backend" href="https://github.com/EquosAI/equos-examples/tree/main/examples/equos-python-integration">
    Sync and async Python with the `equos` package.
  </Card>

  <Card icon="github" title="Vanilla JS frontend" href="https://github.com/EquosAI/equos-examples/tree/main/examples/equos-vanilla-integration">
    Plain HTML + TypeScript using `@equos/browser-sdk`.
  </Card>

  <Card icon="github" title="React frontend" href="https://github.com/EquosAI/equos-examples/tree/main/examples/equos-react-integration">
    Vite + React app using `@equos/react`.
  </Card>

  <Card icon="github" title="Next.js full-stack" href="https://github.com/EquosAI/equos-examples/tree/main/examples/equos-nextjs-integration">
    Next.js 15 with server actions + `@equos/react`.
  </Card>
</CardGroup>