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

> ## Agent Instructions
> Company name is Akhara AI (never Rubric AI). Keep lowercase rubric/rubrics only when meaning grading criteria.
> Expert Review (docs path talent/) is enterprise BYO experts for audit and review: invite customer specialists; do not pitch Akhara recruiting or a public expert career portal. RLHF and domain writing are secondary work types.
> Prefer concrete API examples against public hosts: Environments eval API https://agi.akhara.ai, Control plane PDP https://api.akhara.dev, Evaluation https://app.akhara.ai / https://api.akhara.ai, Expert Review portal https://talent.akhara.ai.
> Do not invent a public hostname for private orchestrators or env API internals.
> Do not confuse control-plane latches with Environments confirmation latches.
> Environments SDK/API examples: curl against https://agi.akhara.ai. Evaluation SDK: from akhara import Akhara and AKHARA_API_KEY.
> Start with /llms.txt for the docs index and OpenAPI links; fetch individual pages as .md exports.

# Quickstart

> Get started with Akhara Evaluation in 5 minutes. Install the SDK, log a sample, and view results in the dashboard.

## Overview

This guide gets you from zero to a scored evaluation in under 5 minutes. You'll:

1. Install the Akhara SDK
2. Get your API key
3. Create a sample
4. Run evaluators and view results in the dashboard

Prefer CI quality gates? See the [CI/CD tutorial](/evaluation/docs/tutorials/ci-cd) for the hosted API and SDK path with gate scripts.

## Prerequisites

* Python 3.8+ or Node.js 16+

## Step 1: Install the SDK

<CodeGroup>
  ```bash pip theme={null}
  pip install akhara
  ```

  ```bash npm theme={null}
  npm install @akhara/sdk
  ```

  ```bash yarn theme={null}
  yarn add @akhara/sdk
  ```
</CodeGroup>

## Step 2: Get your API key

1. Sign up at [app.akhara.ai](https://app.akhara.ai)
2. Navigate to **Settings → API Keys**
3. Click **Create API Key**
4. Copy your key

<Warning>
  Keep your API key secure. Never commit it to version control or expose it in client-side code.
</Warning>

```bash theme={null}
export AKHARA_API_KEY="your_key_here"
```

## Step 3: Create a sample

<CodeGroup>
  ```python Python theme={null}
  from akhara import Akhara

  client = Akhara()  # Uses AKHARA_API_KEY env var

  client.samples.create(
      dataset="my-first-dataset",
      input={"query": "Cancel my order and issue a refund."},
      output={
          "response": "Done. I've cancelled the order and started your refund.",
          "actions": ["cancel_order", "issue_refund"],
      },
      expected={
          "must_include": ["cancel", "refund"],
          "must_not": ["upsell"],
      },
  )

  print("Sample created")
  ```

  ```typescript TypeScript theme={null}
  import Akhara from '@akhara/sdk';

  const client = new Akhara();  // Uses AKHARA_API_KEY env var

  await client.samples.create({
      dataset: "my-first-dataset",
      input: { query: "Cancel my order and issue a refund." },
      output: {
          response: "Done. I've cancelled the order and started your refund.",
          actions: ["cancel_order", "issue_refund"],
      },
      expected: {
          mustInclude: ["cancel", "refund"],
          mustNot: ["upsell"],
      },
  });

  console.log("Sample created");
  ```
</CodeGroup>

## Step 4: View in the dashboard

1. Open [app.akhara.ai](https://app.akhara.ai)
2. Open your project / dataset
3. Inspect the sample and any automated scores

## Step 5: Run an evaluation

```python theme={null}
evaluation = client.evaluations.create(
    name="My First Evaluation",
    dataset="my-first-dataset",
    evaluators=[
        {
            "type": "contains_all",
            "config": {"fields": ["must_include"]},
        },
        {
            "type": "llm_judge",
            "config": {"rubric": "task_completion_v1"},
        },
    ],
)

print(f"Evaluation started: {evaluation.id}")
results = client.evaluations.wait(evaluation.id)
print(results.metrics)
```

## Gate PRs and deploys

Wire the same evaluation into CI with the Akhara SDK. See [CI/CD evaluations](/evaluation/docs/tutorials/ci-cd).

## What's next?

<CardGroup cols={2}>
  <Card title="Account setup" icon="user-gear" href="/evaluation/docs/getting-started/setup">
    Configure your workspace, team, and settings
  </Card>

  <Card title="First evaluation" icon="check" href="/evaluation/docs/getting-started/first-evaluation">
    Deep dive into creating evaluations
  </Card>

  <Card title="API reference" icon="book" href="/evaluation/api-reference/introduction">
    Datasets, evaluations, scores, and auth
  </Card>

  <Card title="CI/CD tutorial" icon="code-branch" href="/evaluation/docs/tutorials/ci-cd">
    Gate PRs and deploys on eval metrics
  </Card>
</CardGroup>

## Common issues

<AccordionGroup>
  <Accordion title="API key not found">
    Set `AKHARA_API_KEY`, or pass it directly:

    ```python theme={null}
    client = Akhara(api_key="your_key")
    ```
  </Accordion>

  <Accordion title="Project or dataset not found">
    Datasets are created on first write in many setups. Check the name for typos, or create the dataset explicitly in the dashboard.
  </Accordion>

  <Accordion title="Rate limit exceeded">
    Free tiers throttle burst traffic. Add retries or upgrade for higher limits.
  </Accordion>
</AccordionGroup>