# GoModel

## Docs

- [Benchmarks](https://gomodel-docs-providers-restructure.mintlify.app/about/benchmarks.md): A summary of GoModel benchmark results, with links to full write-ups and methodology.
- [License](https://gomodel-docs-providers-restructure.mintlify.app/about/license.md): The current GoModel license and how we think about long-term project sustainability.
- [Roadmap to 0.2.0](https://gomodel-docs-providers-restructure.mintlify.app/about/roadmap.md): Condensed GoModel roadmap for version 0.2.0, ordered by user impact.
- [Technical Philosophy](https://gomodel-docs-providers-restructure.mintlify.app/about/technical-philosophy.md): The engineering ideas that shape how GoModel is designed and maintained.
- [Our Values](https://gomodel-docs-providers-restructure.mintlify.app/about/values.md): The values behind GoModel and how we think about building an AI gateway.
- [Who We Are](https://gomodel-docs-providers-restructure.mintlify.app/about/who-we-are.md): The people and organization behind GoModel, and how it relates to Enterpilot.
- [Admin Endpoints](https://gomodel-docs-providers-restructure.mintlify.app/advanced/admin-endpoints.md): Built-in REST API and dashboard for monitoring usage, budgets, models, and gateway health.
- [config.yaml](https://gomodel-docs-providers-restructure.mintlify.app/advanced/config-yaml.md): When to use config.yaml, when not to, and how it interacts with environment variables and Docker.
- [Configuration](https://gomodel-docs-providers-restructure.mintlify.app/advanced/configuration.md): How to configure GoModel using environment variables, .env files, and YAML.
- [Guardrails](https://gomodel-docs-providers-restructure.mintlify.app/advanced/guardrails.md): Intercept and modify requests before they reach LLM providers.
- [Resilience](https://gomodel-docs-providers-restructure.mintlify.app/advanced/resilience.md): Tune retries and the per-provider circuit breaker, and learn when to reach for cross-model failover instead.
- [Responses API](https://gomodel-docs-providers-restructure.mintlify.app/advanced/responses-api.md): Use OpenAI-compatible response creation, lifecycle, input items, and utility endpoints through GoModel.
- [Workflows](https://gomodel-docs-providers-restructure.mintlify.app/advanced/workflows.md): How workflow matching works, including user_path-first precedence and provider-name scoping.
- [Create or update one budget](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/create-or-update-one-budget.md)
- [Create or update one model access override](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/create-or-update-one-model-access-override.md)
- [Create or update one model pricing override](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/create-or-update-one-model-pricing-override.md): Stores USD-only pricing for one selector. More precise selectors override broader selectors at runtime.
- [Delete one budget](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/delete-one-budget.md)
- [Delete one model access override](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/delete-one-model-access-override.md)
- [Delete one model pricing override](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/delete-one-model-pricing-override.md)
- [Get admin runtime configuration](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/get-admin-runtime-configuration.md)
- [Get budget reset settings](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/get-budget-reset-settings.md)
- [Get cached-only usage overview](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/get-cached-only-usage-overview.md)
- [Get conversation thread around an audit log entry](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/get-conversation-thread-around-an-audit-log-entry.md)
- [Get paginated audit log entries](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/get-paginated-audit-log-entries.md)
- [Get paginated usage log entries](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/get-paginated-usage-log-entries.md)
- [Get usage breakdown by model](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/get-usage-breakdown-by-model.md)
- [Get usage breakdown by period](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/get-usage-breakdown-by-period.md)
- [Get usage breakdown by user path](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/get-usage-breakdown-by-user-path.md)
- [Get usage summary](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/get-usage-summary.md)
- [List all registered models with provider info and access state](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/list-all-registered-models-with-provider-info-and-access-state.md)
- [List budgets with current status](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/list-budgets-with-current-status.md)
- [List model access overrides](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/list-model-access-overrides.md): Lists persisted model access overrides by global, provider-wide, model-wide, or exact selector. Selectors support global "/", provider-wide "provider/", model-wide "model", and exact "provider/model" scopes.
- [List model categories with counts](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/list-model-categories-with-counts.md)
- [List model pricing overrides](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/list-model-pricing-overrides.md): Lists persisted USD pricing overrides. Selectors support global "/", provider-wide "provider/", model-wide "model", and exact "provider/model" scopes.
- [Recalculate stored usage costs from current model pricing metadata](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/recalculate-stored-usage-costs-from-current-model-pricing-metadata.md)
- [Reset all budget periods](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/reset-all-budget-periods.md)
- [Reset one budget period](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/reset-one-budget-period.md)
- [Update budget reset settings](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/admin/update-budget-reset-settings.md)
- [Cancel a batch](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/batch/cancel-a-batch.md)
- [Create a native provider batch](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/batch/create-a-native-provider-batch.md)
- [Get a batch](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/batch/get-a-batch.md)
- [Get batch results](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/batch/get-batch-results.md)
- [List batches](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/batch/list-batches.md)
- [Create a chat completion](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/chat/create-a-chat-completion.md)
- [Create embeddings](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/embeddings/create-embeddings.md)
- [Delete a file](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/files/delete-a-file.md)
- [Download file content](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/files/download-file-content.md)
- [Get file metadata](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/files/get-file-metadata.md)
- [List files](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/files/list-files.md)
- [Upload a file](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/files/upload-a-file.md)
- [List available models](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/models/list-available-models.md)
- [Provider passthrough](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/passthrough/provider-passthrough.md): Runtime-configurable passthrough endpoint under /p/{provider}/{endpoint}; enabled by default via server.enable_passthrough_routes. The endpoint path is opaque and may proxy JSON, binary, or SSE responses with upstream status codes preserved. For multi-segment provider endpoints, clients that rely on…
- [Provider passthrough](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/passthrough/provider-passthrough-1.md): Runtime-configurable passthrough endpoint under /p/{provider}/{endpoint}; enabled by default via server.enable_passthrough_routes. The endpoint path is opaque and may proxy JSON, binary, or SSE responses with upstream status codes preserved. For multi-segment provider endpoints, clients that rely on…
- [Provider passthrough](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/passthrough/provider-passthrough-2.md): Runtime-configurable passthrough endpoint under /p/{provider}/{endpoint}; enabled by default via server.enable_passthrough_routes. The endpoint path is opaque and may proxy JSON, binary, or SSE responses with upstream status codes preserved. For multi-segment provider endpoints, clients that rely on…
- [Provider passthrough](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/passthrough/provider-passthrough-3.md): Runtime-configurable passthrough endpoint under /p/{provider}/{endpoint}; enabled by default via server.enable_passthrough_routes. The endpoint path is opaque and may proxy JSON, binary, or SSE responses with upstream status codes preserved. For multi-segment provider endpoints, clients that rely on…
- [Provider passthrough](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/passthrough/provider-passthrough-4.md): Runtime-configurable passthrough endpoint under /p/{provider}/{endpoint}; enabled by default via server.enable_passthrough_routes. The endpoint path is opaque and may proxy JSON, binary, or SSE responses with upstream status codes preserved. For multi-segment provider endpoints, clients that rely on…
- [Provider passthrough](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/passthrough/provider-passthrough-5.md): Runtime-configurable passthrough endpoint under /p/{provider}/{endpoint}; enabled by default via server.enable_passthrough_routes. The endpoint path is opaque and may proxy JSON, binary, or SSE responses with upstream status codes preserved. For multi-segment provider endpoints, clients that rely on…
- [Provider passthrough](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/passthrough/provider-passthrough-6.md): Runtime-configurable passthrough endpoint under /p/{provider}/{endpoint}; enabled by default via server.enable_passthrough_routes. The endpoint path is opaque and may proxy JSON, binary, or SSE responses with upstream status codes preserved. For multi-segment provider endpoints, clients that rely on…
- [Cancel a response](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/responses/cancel-a-response.md)
- [Compact response input](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/responses/compact-response-input.md)
- [Count response input tokens](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/responses/count-response-input-tokens.md)
- [Create a model response (Responses API)](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/responses/create-a-model-response-responses-api.md)
- [Delete a response](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/responses/delete-a-response.md)
- [Get a response](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/responses/get-a-response.md)
- [List response input items](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/responses/list-response-input-items.md)
- [Health check](https://gomodel-docs-providers-restructure.mintlify.app/api-reference/system/health-check.md)
- [Aliases](https://gomodel-docs-providers-restructure.mintlify.app/features/aliases.md): Use GoModel aliases to expose stable model names and test model swaps without changing app code.
- [Budgets](https://gomodel-docs-providers-restructure.mintlify.app/features/budgets.md): Set spend limits per user path and enforce them through workflow budget controls.
- [Cache](https://gomodel-docs-providers-restructure.mintlify.app/features/cache.md): How GoModel response caching works, how to enable exact and semantic cache layers, and what is included in the exact-cache key.
- [Failover](https://gomodel-docs-providers-restructure.mintlify.app/features/failover.md): Configure GoModel failover with manual rules, understand experimental auto mode, and know when fallback attempts run.
- [Passthrough API](https://gomodel-docs-providers-restructure.mintlify.app/features/passthrough-api.md): Use provider-native APIs through GoModel, including Anthropic SDK requests routed through the passthrough endpoint.
- [User Path](https://gomodel-docs-providers-restructure.mintlify.app/features/user-path.md): Use user_path to scope keys, model access, model lists, workflows, usage, and audit logs.
- [Quick Start](https://gomodel-docs-providers-restructure.mintlify.app/getting-started/quickstart.md): GoModel AI gateway quick start: run an OpenAI-compatible LLM gateway in 30 seconds, send your first request, and open the admin panel.
- [GoModel & Claude Code](https://gomodel-docs-providers-restructure.mintlify.app/guides/claude-code.md): Step-by-step guide for routing Claude Code through GoModel with Anthropic passthrough.
- [GoModel & Codex](https://gomodel-docs-providers-restructure.mintlify.app/guides/codex.md): Step-by-step guide for routing Codex through GoModel.
- [GoModel & OpenClaw](https://gomodel-docs-providers-restructure.mintlify.app/guides/openclaw.md): Use GoModel as an OpenAI-compatible AI gateway for OpenClaw, with recommended OpenAI models and a production-ready setup.
- [GoModel & Coding Agents](https://gomodel-docs-providers-restructure.mintlify.app/guides/opencode-and-other-agents.md): Step-by-step guide for OpenAI-compatible coding agents with GoModel.
- [Prometheus Metrics](https://gomodel-docs-providers-restructure.mintlify.app/guides/prometheus-metrics.md): Configure and scrape GoModel's Prometheus metrics endpoint.
- [Azure OpenAI](https://gomodel-docs-providers-restructure.mintlify.app/providers/azure.md): Configure Azure OpenAI in GoModel using deployment-based URLs and the api-version query parameter.
- [Amazon Bedrock](https://gomodel-docs-providers-restructure.mintlify.app/providers/bedrock.md): Configure Amazon Bedrock in GoModel using AWS credentials and the Bedrock Runtime Converse API.
- [DeepSeek](https://gomodel-docs-providers-restructure.mintlify.app/providers/deepseek.md): Configure DeepSeek V4 in GoModel and understand how reasoning effort is mapped to DeepSeek's reasoning_effort field.
- [Google Gemini](https://gomodel-docs-providers-restructure.mintlify.app/providers/gemini.md): Configure Google Gemini via AI Studio in GoModel, choose native or OpenAI-compatible routing, and understand image_url behavior.
- [Ollama](https://gomodel-docs-providers-restructure.mintlify.app/providers/multiple-ollama.md): Use one GoModel instance with multiple Ollama providers through suffixed environment variables and provider-qualified model IDs.
- [Oracle GenAI](https://gomodel-docs-providers-restructure.mintlify.app/providers/oracle.md): Configure Oracle GenAI's OpenAI-compatible endpoint in GoModel, including the required OCI policy and configured model lists.
- [Providers Overview](https://gomodel-docs-providers-restructure.mintlify.app/providers/overview.md): Supported AI providers in GoModel and which ones have dedicated configuration guides.
- [Google Vertex AI](https://gomodel-docs-providers-restructure.mintlify.app/providers/vertex.md): Configure Gemini on Google Vertex AI in GoModel, including ADC and service-account authentication, regions, and native vs OpenAI-compatible routing.
- [vLLM](https://gomodel-docs-providers-restructure.mintlify.app/providers/vllm.md): Route OpenAI-compatible GoModel requests to one or more vLLM servers, including slash-shaped Hugging Face model IDs.

## OpenAPI Specs

- [openapi](https://gomodel-docs-providers-restructure.mintlify.app/openapi.json)

## Optional

- [Discord](https://discord.gg/gaEB9BQSPH)