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

# Start Here

> Get your first successful AI Stats API request in under 5 minutes, then choose the right path for SDKs, routing, agents, or production rollout.

Use this page when you want to get moving quickly and do not yet know which part of the docs you need.

You can think of AI Stats in one sentence:

* one API for models, providers, routing, pricing, and async AI workflows

## Fastest path

If you only want the shortest route to first success:

1. Create an API key in the dashboard.
2. Send one request to a `:free` model.
3. Confirm the response shape.
4. Then choose the integration path that matches your app.

<Note>
  Free models can be used with zero deposited credits. Paid models require available wallet balance.
</Note>

## First request

<CodeGroup>
  ```bash cURL theme={null}
  curl https://api.phaseo.app/v1/responses \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "model": "google/gemma-3-27b:free",
      "input": "Reply with: docs ready",
      "temperature": 0
    }'
  ```

  ```typescript TypeScript SDK theme={null}
  import AIStats from "@ai-stats/sdk";

  const client = new AIStats({ apiKey: process.env.AI_STATS_API_KEY! });

  const response = await client.generateResponse({
    model: "google/gemma-3-27b:free",
    input: "Reply with: docs ready",
    temperature: 0,
  });

  console.log(response.output_text);
  ```

  ```python Python SDK theme={null}
  from ai_stats import AIStats

  client = AIStats(api_key="YOUR_API_KEY")

  response = client.generate_response(
      {
          "model": "google/gemma-3-27b:free",
          "input": "Reply with: docs ready",
          "temperature": 0,
      }
  )

  print(response.get("output_text"))
  ```
</CodeGroup>

If that works, go to the [Quickstart](./quickstart) and keep building from there.

***

## Choose your starting point

If you already have an integration or toolchain, start from the closest match instead of reading the docs from the top.

<Columns cols={2}>
  <Card title="I'm coming from OpenAI" icon="arrow-right-left" href="./migration-guides/from-openai">
    Keep the OpenAI-compatible shape, swap the base URL and key, and verify model support.
  </Card>

  <Card title="I'm coming from OpenRouter" icon="arrow-right-left" href="./migration-guides/from-openrouter">
    Move your existing routing setup over with parity checks and staged rollout guidance.
  </Card>

  <Card title="I'm sending raw HTTP requests" icon="globe" href="./quickstart">
    Start from cURL and the Responses API, then move into the endpoint reference when needed.
  </Card>

  <Card title="I'm using the TypeScript SDK" icon="file-code-2" href="./sdk-reference/typescript/overview">
    Use the TypeScript client as your main entry point for Responses, chat, images, audio, and more.
  </Card>

  <Card title="I'm using the Python SDK" icon="snake" href="./sdk-reference/python/overview">
    Start from the Python client if your integration lives in scripts, workers, backends, or notebooks.
  </Card>

  <Card title="I'm using the AI SDK" icon="sparkles" href="./sdk-reference/sdk/ai-sdk">
    Connect Vercel AI SDK apps to AI Stats without rebuilding your prompt or model flow.
  </Card>

  <Card title="I'm using Codex or Claude Code" icon="bot" href="./guides/integrations/index">
    Set up the gateway, Docs MCP, and coding-agent integrations from one place.
  </Card>

  <Card title="I just need examples" icon="code" href="./guides/examples">
    Jump straight to copy-paste requests and sample projects if you already know the basics.
  </Card>
</Columns>

***

## What are you trying to do?

<Columns cols={2}>
  <Card title="Make my first request" icon="rocket" href="./quickstart">
    Start with one successful text request, then learn where to read output and debug failures.
  </Card>

  <Card title="Use an SDK" icon="package" href="./sdk-reference/typescript/overview">
    Pick the client SDK that matches your stack and start from real wrapper examples.
  </Card>

  <Card title="Connect a coding agent" icon="bot" href="./guides/integrations/index">
    Set up Codex, Claude Code, OpenCode, or Docs MCP against AI Stats.
  </Card>

  <Card title="Migrate an existing integration" icon="arrow-right-left" href="./migration-guides/index">
    Move from OpenAI, OpenRouter, Anthropic, Vercel, LiteLLM, or another gateway.
  </Card>

  <Card title="Control routing and providers" icon="route" href="./guides/routing-and-fallbacks">
    Choose provider order, ranking, regional offers, presets, and failover behavior.
  </Card>

  <Card title="Run async jobs" icon="clapperboard" href="./cookbook/async-video-webhooks">
    Build video, music, and batch workflows with polling, webhooks, and status retrieval.
  </Card>
</Columns>

***

## Most useful pages

<Columns cols={2}>
  <Card title="Quickstart" icon="rocket" href="./quickstart">
    The shortest path from signup to first successful request.
  </Card>

  <Card title="API Reference" icon="server" href="./api-reference/introduction">
    Base URL, auth, endpoint families, and endpoint-by-endpoint request details.
  </Card>

  <Card title="Examples" icon="code" href="./guides/examples">
    Copy-paste requests and sample projects across common workflows.
  </Card>

  <Card title="Cookbook" icon="chef-hat" href="./cookbook/index">
    Scenario-driven recipes for routing, presets, async jobs, search, and agent workflows.
  </Card>

  <Card title="Authentication" icon="key" href="./developers/authentication">
    Key format, bearer headers, and common auth mistakes.
  </Card>

  <Card title="Error Handling" icon="triangle-alert" href="./api-reference/errors">
    Understand failed requests quickly and fix the common causes.
  </Card>
</Columns>

***

## If you are using agents

AI Stats is set up to work well with coding agents and AI tools, not just humans reading docs in a browser.

Start here:

<Columns cols={2}>
  <Card title="Docs MCP" icon="plug-zap" href="./guides/integrations/docs-mcp">
    Let Codex, Claude Code, Cursor, or VS Code search the live AI Stats docs while they work.
  </Card>

  <Card title="skill.md" icon="file-text" href="https://ai-stats.phaseo.app/skill.md">
    Capability summary for agents that need to understand what AI Stats can do and how requests work.
  </Card>

  <Card title="Integrations" icon="plug" href="./guides/integrations/index">
    Set up coding tools and editor workflows around the gateway.
  </Card>

  <Card title="Agent SDK" icon="bot" href="./sdk-reference/agent-sdk/overview">
    Build tool-using, gateway-backed agent loops across the supported SDK languages.
  </Card>
</Columns>

***

## Explore models and providers

Use the data surfaces when you need to choose before you build:

<Columns cols={2}>
  <Card title="Browse Models" icon="database" href="https://ai-stats.phaseo.app/models">
    Find models, pricing, context windows, capabilities, and provider offers in one place.
  </Card>

  <Card title="Compare Models" icon="diff" href="https://ai-stats.phaseo.app/compare">
    Compare performance, cost, and metadata side by side before you commit to one route.
  </Card>
</Columns>
