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.

Step 1: Create an API Key

Get your API key from the Ojin dashboard. This will allow you to use Ojin in your applications through a secure environment.

Never hardcode your API key directly in your application code or commit it to version control.

Step 2: 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.

1. Create & configure your agent in the dashboard (using your API key from Step 1)

2. Embed the widget 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 or Pipecat turns your TTS audio into a synchronized talking avatar. Pick ojin/oris-presence (flagship) or ojin/oris-portrait (cost-effective) with its config_id.

1. Build with the Python SDK — install, authenticate, and stream your first avatar

2. Or drop the avatar into a Pipecat voice agent

Troubleshooting

Run into a snag? Check the Troubleshooting guide or reach out to support.

Next Steps

Build with the Python SDK

Install, authenticate, and stream your first avatar

Open the SDK guide →

Human Agent

Learn more about the full agent product

View Human Agent →