---
title: "Get an AI Gateway"
url: "https://nov18-dev.movespot.fyi/apis/konnect-ai-gateway-dev-0/versions/eaabd2fa-a9d5-44cc-b086-e210c9c21bf3/operations/get-ai-gateway"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-ai-gateway-dev-0/versions/eaabd2fa-a9d5-44cc-b086-e210c9c21bf3.md

# Get an AI Gateway

`GET` `/ai-gateways/{gatewayId}`

Operation ID: `get-ai-gateway`

Returns the details of a specific AI Gateway.

## Path parameters

- `gatewayId` (string, uuid, required) - The unique ID of the AI Gateway.

## Responses

- `200` - A successful response returning an AI Gateway.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found
- `429` - Too Many Requests

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect AI Gateway
  version: 0.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /ai-gateways/{gatewayId}:
    parameters:
      - $ref: "#/components/parameters/AIGatewayId"
    get:
      operationId: get-ai-gateway
      summary: Get an AI Gateway
      description: Returns the details of a specific AI Gateway.
      responses:
        "200":
          $ref: "#/components/responses/GetAIGatewayResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      tags:
        - AI Gateways
security:
  - konnectAccessToken: []
components:
  parameters:
    AIGatewayId:
      name: gatewayId
      in: path
      required: true
      description: The unique ID of the AI Gateway.
      example: bf138ba2-c9b1-4229-b268-04d9d8a6410b
      schema:
        $ref: "#/components/schemas/UUID"
  responses:
    GetAIGatewayResponse:
      description: A successful response returning an AI Gateway.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AIGateway"
          examples:
            AI Gateway Response:
              $ref: "#/components/examples/AIGatewayExample"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
    TooManyRequests:
      description: Too Many Requests
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/TooManyRequestsError"
  schemas:
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    AIGateway:
      type: object
      properties:
        name:
          description: The name of the AI Gateway.
          type: string
          example: My AI Gateway
        description:
          description: The description of the AI Gateway.
          type: string
          example: An AI Gateway for my organization.
        labels:
          $ref: "#/components/schemas/PublicLabels"
        id:
          $ref: "#/components/schemas/UUID"
        endpoints:
          description: Object containing AI Gateway access endpoints.
          type: object
          additionalProperties: false
          properties:
            configuration:
              description: Configuration Endpoint.
              type: string
              format: url
              example: https://acfe5f253f.cp.konghq.com
              readOnly: true
            telemetry:
              description: Telemetry Endpoint.
              type: string
              format: url
              example: https://acfe5f253f.tp0.konghq.com
              readOnly: true
          required:
            - configuration
            - telemetry
        config_hash:
          description: >
            The hash of the latest configuration for the gateway. Every change
            to an entity

            under this gateway will result in a new config_hash being generated.

            The config hash can be used to verify if the config hash of an AI
            Gateway

            node is up to date with the AI Gateway. The config hash will be the
            same if they are in sync.
          type: string
          readOnly: true
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: true
      required:
        - name
        - id
        - endpoints
        - config_hash
        - created_at
        - updated_at
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    TooManyRequestsError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 429
            title:
              example: Too Many Requests
            type:
              example: https://httpstatuses.com/429
            instance:
              example: kong:trace:1234567890
            detail:
              example: Too Many Requests
    PublicLabels:
      description: >
        Public labels store information about an entity that can be used for
        filtering a list of objects.


        Public labels are intended to store **PUBLIC** metadata. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        category: finance
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: PublicLabels
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
  examples:
    AIGatewayExample:
      value:
        id: bf138ba2-c9b1-4229-b268-04d9d8a6410b
        name: My AI Gateway
        description: An AI Gateway for my organization.
        labels:
          env: production
        endpoints:
          configuration: https://acfe5f253f.cp.konghq.com
          telemetry: https://acfe5f253f.tp0.konghq.com
        config_hash: 2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824
        created_at: 2024-01-01T00:00:00.000Z
        updated_at: 2024-01-01T00:00:00.000Z
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
