---
title: "Get branch AI Gateway endpoint"
method: GET
path: "/projects/{project_id}/branches/{branch_id}/ai_gateway"
tags: ["AI Gateway"]
---

# Get branch AI Gateway endpoint

`GET /projects/{project_id}/branches/{branch_id}/ai_gateway`

## Request

- Base URL: `https://console.neon.tech/api/v2`
- URL: `https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/ai_gateway`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `zenith`
  - API key in cookie `keycloak_token`

Returns the AI Gateway endpoint host for the specified branch, used to
render code-snippet base URLs. A 200 response means the branch is
registered and this region serves the AI gateway. A 404 response
includes a `reason` field indicating why the gateway is unavailable.

**Note**: This endpoint is currently in Private Beta.

## Response `200`

AI Gateway is enabled for this branch

- BranchAiGateway
  - `enabled` boolean, required: Always `true` in 200 responses. Present for forward compatibility, mirroring BranchStorage.enabled.
  - `base_url` string, uri, required: The AI-gateway endpoint root for this branch — an OpenAI-compatible base URL. No dialect path is included; clients append the route (e.g. `/ai-gateway/openai/v1/responses`) themselves.

## Other responses

- `404`: AI Gateway is not available for this branch, or the project/branch was not found. The body is always `BranchAiGatewayNotEnabled` — see `reason` for the exact cause.
- `default`: General Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.

---

[API](https://skmtc.dev/neon/apis/neon-api.md) · [All operations](https://skmtc.dev/neon/apis/neon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/neon/apis/neon-api/revisions/cfde79a5c713?raw)