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

# DeerAPI Documentation

> DeerAPI documentation for OpenAI-compatible text, image, video, audio, and music APIs, with quick starts, integration guides, pricing, and help references.

## Access AI models through one API

DeerAPI provides OpenAI-compatible access to text, image, video, audio, and music models through a unified API account. Start with a DeerAPI API Key, choose a current model ID, and call the endpoint that matches your workflow.

<CardGroup cols={3}>
  <Card title="Quick Start" icon="bolt" href="/quick-start/quick-start">
    Configure the base URL, add your API Key, and make a first request.
  </Card>

  <Card title="Live Model List" icon="list" href="https://api.deerapi.com/pricing">
    Browse available models and pricing from the DeerAPI dashboard.
  </Card>

  <Card title="API Dashboard" icon="gauge" href="https://api.deerapi.com/panel">
    Manage API Keys, review logs, and monitor usage.
  </Card>
</CardGroup>

## Explore by workflow

<CardGroup cols={2}>
  <Card title="Text and reasoning" icon="message" href="/api/text/openai/chat">
    Call GPT, Claude, Gemini, and other chat models through OpenAI-compatible endpoints.
  </Card>

  <Card title="Image generation" icon="image" href="/api/image/openai/generate">
    Generate, edit, and manage images with OpenAI-compatible and provider-specific APIs.
  </Card>

  <Card title="Video generation" icon="film" href="/api/video/veo3/async/create">
    Create and query video tasks for Sora, Veo, Kling, Runway, and related workflows.
  </Card>

  <Card title="Audio and music" icon="microphone" href="/api/audio/openai/tts">
    Build transcription, translation, speech, sound effect, and music workflows.
  </Card>
</CardGroup>

## Start in minutes

The following example uses the OpenAI SDK format with DeerAPI settings:

<CodeGroup>
  ```python Python theme={null}
  import os
  from openai import OpenAI

  client = OpenAI(
      api_key=os.environ["DEERAPI_KEY"],
      base_url="https://api.deerapi.com/v1",
  )

  response = client.chat.completions.create(
      model="your-model-id",
      messages=[{"role": "user", "content": "Hello"}],
  )
  print(response.choices[0].message.content)
  ```

  ```typescript TypeScript theme={null}
  import OpenAI from "openai";

  const client = new OpenAI({
    apiKey: process.env.DEERAPI_KEY,
    baseURL: "https://api.deerapi.com/v1",
  });

  const response = await client.chat.completions.create({
    model: "your-model-id",
    messages: [{ role: "user", content: "Hello" }],
  });
  console.log(response.choices[0].message.content);
  ```
</CodeGroup>

## More resources

<CardGroup cols={2}>
  <Card title="Integration Guides" icon="puzzle-piece" href="/integration/deerapi">
    Connect DeerAPI to popular AI tools and OpenAI-compatible clients.
  </Card>

  <Card title="Error Reference" icon="triangle-exclamation" href="/help/error-codes">
    Diagnose API Key, base URL, model ID, rate limit, and service errors.
  </Card>
</CardGroup>