Help CenterNairi API
Quickstart

Overview

Configure, deploy, and talk to your first agent in a few minutes.

This quickstart walks you through the full end-to-end flow against the Nairi API:

  1. Create an agent and attach a rule and a vault.
  2. Deploy the agent so it starts answering prompts.
  3. Start a conversation, wait for the reply, and send a follow-up.

Every step shows the equivalent code in bash, TypeScript, Ruby, Python, and Go, so you can drop the snippets straight into whatever you're building.

Prerequisites

  • A Nairi organization with an API key. Generate one from your organization's settings in the Nairi dashboard.

  • The API key exported as NAIRI_API_KEY in your shell or process environment:

    export NAIRI_API_KEY=your-key-here

  • For the bash flow you'll also need curl and jq installed locally.

Treat API keys like passwords. Never commit them to source control. If a key is compromised, revoke it from the dashboard.

Base URL

All endpoints below are served from:

https://api.nairi.ai/api/public/v1

Walkthrough

1. Configure and deploy an agent

Create the agent, attach a rule and a vault, then deploy it.

2. Drive a conversation

Start a conversation, poll for the reply, and send a follow-up.

3. Full example

The whole flow as one script, in every supported language.

Overview

Programmatic access to your Nairi organization. Manage agents, conversations, artifacts, vaults, and more.

1. Configure and deploy an agent

Create an agent, attach a rule and a vault, then deploy it.

On this page

PrerequisitesBase URLWalkthrough