Quickstart

This walks through the fastest path to a working voice agent: a Simple Flow hotline project on app.v2.nairon.xyz. If you’re integrating Nairon as an API instead of building a hotline, skip to Quickstart: the platform API below, or go straight to the Developer guide.

1. Create your account and organization

1. Go to https://app.v2.nairon.xyz and sign up with an email and password.
2. Confirm your email, then log in.
3. Create an organization — the top-level container for billing and membership.

2. Create a project

Projects live inside an organization and hold flows, phone numbers, knowledge bases, and agent profiles. From your organization dashboard, click New Project and give it a name. Leave the project type as the default (hotline) — a phone-answering agent project. (Platform-type projects, for API-only consumption, are covered in the Developer guide.)

3. Build a Simple Flow

A flow defines how your agent handles a call. The fastest flow type is Simple Flow — a guided form rather than a graph:

1. Go to Flows → New Flow → choose Simple Flow.
2. Set the intro line — the first thing the agent says.
3. Add one or more FAQ topics (optionally backed by a knowledge base) and/or questions the agent should ask and store as variables.
4. Optionally enable forward to a human, a callback offer, and the end-of-call survey.
5. Save the flow. Saving a flow version and activating it are the same action for a new flow — see Flows for how versions and publishing work in general (graph flows separate these steps).

For anything beyond FAQ + a few questions — branching logic, pre/post-call automation, integrations — use a Graph Flow instead; see Flows.

4. Attach a phone number and test

1. Go to Phone Numbers, allocate a Nairon-provided number (or configure a partner/external SIP number), and assign your flow to it.
2. Use Test in the flow editor to place a simulated or live test call against the flow before it’s attached to a real number, or call the number directly once assigned.

5. Check the call

After a test or real call, open Call History to see the transcript, and Analytics for aggregate metrics (call count, duration, drop-off). See Call History, Analytics & Simulation.

Quickstart: the platform API

If you want to call Nairon’s OpenAI-compatible endpoints directly rather than building a hotline:

1. Create a project with type = platform (or ask an org admin to). This redirects you to platform.v2.nairon.xyz.
2. On the platform console, mint a secret API key (nrn_sk_...).
3. Call the platform API with the OpenAI Python client, pointing base_url at https://api.v2.nairon.xyz/v1:

from openai import OpenAI

client = OpenAI(
    api_key="NAIRON_API_KEY",  # your nrn_sk_... key
    base_url="https://api.v2.nairon.xyz/v1",
)

resp = client.chat.completions.create(
    model="auto",  # or a specific catalogue model tag
    messages=[{"role": "user", "content": "Say hello in one sentence."}],
)
print(resp.choices[0].message.content)

See the Developer guide and the API Reference for the full surface (chat, speech, transcription, realtime, batch, knowledge bases) and the service-api REST/MCP control plane for managing flows and reading usage programmatically.