API7 Docs
API7 GatewayAPI7 Enterprise Admin APIsGet an AI Gateway group

Get an AI Gateway group

GET /api/ai_gateway_groups/{ai_gateway_group_id}

GET /api/ai_gateway_groups/{ai_gateway_group_id}

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

Path Parameters

ai_gateway_group_id*string

AI Gateway group ID.

Length1 <= length

Response Body

application/json

application/json

application/json

curl -X GET "$API_BASE_URL/api/ai_gateway_groups/abc1234567890"

Successfully retrieved or modified the AI Gateway group.

{
  "value": {
    "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
    "name": "us-west-rsc",
    "description": "My AI Gateway group.",
    "config": {
      "image_tag": "latest"
    },
    "created_at": 1742288232,
    "updated_at": 1742288235
  }
}
Complete operation details and schema variants

GET /api/ai_gateway_groups/{ai_gateway_group_id}

Get an AI Gateway group

IAM Action: ai_gateway:GetAIGatewayGroup, Resource: arn:api7:ai_gateway:aigatewaygroup/%s Returns the specified AI Gateway group by ID.

Parameters

  • ai_gateway_group_id (path, string, required): AI Gateway group ID.

Responses

  • 200: Successfully retrieved or modified the AI Gateway group.
  • allOf variant 1
  • value (object, optional): The specific resource.
  • allOf variant 2
  • value (object, optional):
  • value.id (string, optional): The object ID.
  • value.name (string, optional): The object name.
  • value.description (string, optional): AI Gateway group description.
  • value.config (object, optional): Configuration for the AI Gateway group.
  • value.config.image_tag (string, optional): The AISIX (AI Gateway) image tag to deploy.
  • value.created_at (integer, optional): The object created timestamp.
  • value.updated_at (integer, optional): The object updated timestamp.
  • 400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
  • value (object, optional): The specific resource.
  • error_msg (string, optional): The error message.
  • 404: Not Found — The requested resource does not exist or has been deleted. Response fields (application/json): identical to GET /api/ai_gateway_groups/{ai_gateway_group_id}, response 400 above.

cURL

curl -X GET '$API_BASE_URL/api/ai_gateway_groups/{ai_gateway_group_id}'