> ## Documentation Index
> Fetch the complete documentation index at: https://gomodel-feature-failover-management.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> GoModel AI gateway quick start: run an OpenAI-compatible LLM gateway in 30 seconds, send your first request, and open the admin panel.

## Run GoModel in 30 Seconds

GoModel is an OpenAI-compatible AI gateway. You can connect one endpoint and
route traffic across OpenAI, Anthropic, Gemini, DeepSeek, xAI, Groq, OpenRouter,
Z.ai, Azure OpenAI, Oracle GenAI, Ollama, and more while keeping auth, audit logs, and
admin visibility in one place.

### 1. Start GoModel

```bash theme={null}
docker run --rm -p 8080:8080 \
  -e LOGGING_ENABLED=true \
  -e LOGGING_LOG_BODIES=true \
  -e LOG_FORMAT=text \
  -e LOGGING_LOG_HEADERS=true \
  -e GOMODEL_MASTER_KEY="change-me" \
  -e OPENAI_API_KEY="sk-..." \
  enterpilot/gomodel
```

<Note>
  Set at least one provider credential or base URL
  (`OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, `GEMINI_API_KEY`,
  `DEEPSEEK_API_KEY`, `XAI_API_KEY`, `GROQ_API_KEY`, `OPENROUTER_API_KEY`,
  `ZAI_API_KEY`, `AZURE_API_KEY` + `AZURE_BASE_URL`,
  `ORACLE_API_KEY` + `ORACLE_BASE_URL`,
  `OLLAMA_BASE_URL`) or GoModel will have no models to route. GoModel also
  works well with additional OpenAI-compatible providers out of the box.
</Note>

### 2. Send your first request

Use `curl` or the OpenAI SDKs for Python and JavaScript against the same
OpenAI-compatible endpoint:

<CodeGroup>
  ```bash curl theme={null}
  curl http://localhost:8080/v1/chat/completions \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer change-me" \
    -d '{
      "model": "gpt-4o-mini",
      "messages": [{"role": "user", "content": "Say hello in one sentence."}]
    }'
  ```

  ```python Python theme={null}
  from openai import OpenAI

  client = OpenAI(
      base_url="http://localhost:8080/v1",
      api_key="change-me",
  )

  completion = client.chat.completions.create(
      model="gpt-4o-mini",
      messages=[{"role": "user", "content": "Say hello in one sentence."}],
  )

  print(completion.choices[0].message.content)
  ```

  ```javascript JavaScript theme={null}
  import OpenAI from "openai";

  const client = new OpenAI({
    baseURL: "http://localhost:8080/v1",
    apiKey: "change-me",
  });

  const completion = await client.chat.completions.create({
    model: "gpt-4o-mini",
    messages: [{ role: "user", content: "Say hello in one sentence." }],
  });

  console.log(completion.choices[0].message.content);
  ```
</CodeGroup>

### 3. Open the Admin Panel

Open this URL in your browser:

`http://localhost:8080/admin/dashboard`

<Tip>
  Dashboard UI is enabled by default (`ADMIN_UI_ENABLED=true`). Admin API
  endpoints are at `/admin/*` and use the same bearer auth as the main
  API.
</Tip>

## Verify Models

List currently available models:

```bash theme={null}
curl -s http://localhost:8080/v1/models \
  -H "Authorization: Bearer change-me"
```

Use one of those model IDs in your requests.

## Admin Panel Preview

### Usage Analytics

<img src="https://mintcdn.com/gomodel-feature-failover-management/YT2KtfVJGelOxQQw/getting-started/images/usage-analytics.png?fit=max&auto=format&n=YT2KtfVJGelOxQQw&q=85&s=0beda6815814f886b8f5c095109357e5" alt="GoModel AI gateway usage analytics dashboard" width="2182" height="1346" data-path="getting-started/images/usage-analytics.png" />

### Audit Logs

<img src="https://mintcdn.com/gomodel-feature-failover-management/YT2KtfVJGelOxQQw/getting-started/images/audit-logs.png?fit=max&auto=format&n=YT2KtfVJGelOxQQw&q=85&s=853b9a3700c8343b9bc1649734affe51" alt="GoModel AI gateway audit logs dashboard" width="2192" height="1358" data-path="getting-started/images/audit-logs.png" />

## Next Steps

* Understand response caching: [Cache](/features/cache)
* Add spend limits: [Budgets](/features/budgets)
* Configure production settings: [Configuration](/advanced/configuration)
* Add request policies: [Guardrails](/advanced/guardrails)
* Connect OpenClaw: [Using GoModel with OpenClaw](/guides/openclaw)
