> For the complete documentation index, see [llms.txt](https://docs.ojin.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ojin.ai/getting-started/quickstart.md).

# Quickstart

Get up and running with Ojin in minutes.

This guide walks you through both paths, deploying a full conversational agent with the no-code Human Agent app, or driving a real-time face model from your own pipeline with the Python SDK.

## Choose Your Path

Ojin offers two ways to build with real-time AI, start with whichever fits:

### Deploy a Human Agent, no code (fastest)

Deploy an end-to-end conversational AI agent with a visual avatar. Ojin handles the entire pipeline, or bring your own speech-to-speech provider. No pipeline assembly required. **No API key needed**: you build the agent in the dashboard and the widget talks to Ojin on its own.

1. [Create & configure your agent](/apps/overview/configure.md) in the dashboard
2. [Embed the widget](/apps/overview/widget-integration.md) on your site. One HTML tag, done

### Build with the SDK. Your own pipeline

Use Ojin's real-time face models for the visual avatar layer in your own conversational pipeline. You control the full stack, STT, LLM, TTS, and the [Python SDK](/models/build-with-python-sdk.md) or [Pipecat](/models/introduction/integrations.md) turns your TTS audio into a synchronized talking avatar. Pick [`ojin/human-presence`](/models/human-presence.md) (flagship) or [`ojin/human-portrait`](/models/human-portrait.md) (cost-effective) with its `config_id`.

1. [Get your API key from the Ojin dashboard](/getting-started/authentication.md). This path calls Ojin from your own backend, so it needs one
2. [Build with the Python SDK](/models/build-with-python-sdk.md), install, authenticate, and stream your first avatar
3. Or drop the avatar into a [Pipecat](/models/introduction/integrations.md) voice agent

{% hint style="warning" %}
Never hardcode your API key directly in your application code or commit it to version control.
{% endhint %}

## Troubleshooting

Run into a snag? Check the [Troubleshooting guide](/guides/troubleshooting.md) or [reach out to support](/getting-started/support.md).

## Next Steps

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Build with the Python SDK</strong></td><td>Install, authenticate, and stream your first avatar.</td><td><a href="/models/build-with-python-sdk.md">Python SDK</a></td></tr><tr><td><strong>Human Agent</strong></td><td>Learn more about the full agent product.</td><td><a href="/apps/overview.md">Human Agent</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ojin.ai/getting-started/quickstart.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.