API7 Docs
API7 GatewayAPI7 Enterprise Admin APIsList model catalog entries

List model catalog entries

GET /api/model_catalogs

GET /api/model_catalogs

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

Query Parameters

direction?string

Order to list the resources by. The sorting index follows the configuration of order_by.

Default"desc"

Value in

  • "asc"
  • "desc"
page_size?integer

Number of resources listed per page. Used together with page. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.

Formatint32
Range1 <= value
page?integer

Page number of the listed resources. Used together with page_size. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.

Formatint32
Range1 <= value
search?string

Condition to search resources by.

order_by?string

Field used to order catalog entries.

Default"provider"

Value in

  • "provider"
  • "model"
  • "name"
  • "status"
  • "created_at"
  • "updated_at"
provider?string

Filter catalog entries by canonical provider.

status?string

Filter catalog entries by status.

Value in

  • "active"
  • "deprecated"
compact?boolean

Return the compact dropdown-oriented item shape when true.

Defaultfalse

Response Body

application/json

application/json

curl -X GET "$API_BASE_URL/api/model_catalogs?search=version%253Dv2"

Successfully retrieved the paginated model catalog.

{
  "total": 1,
  "list": [
    {
      "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
      "provider": "gemini",
      "model": "anthropic.claude-3-5-sonnet-20240620-v1:0",
      "name": "Gemini 1.5 Pro",
      "status": "active",
      "source": {
        "provider": "google"
      },
      "created_at": 1742288232,
      "updated_at": 1742288235
    }
  ]
}
Complete operation details and schema variants

GET /api/model_catalogs

List model catalog entries

IAM Action: ai_gateway:ListModelCatalogs, Resource: arn:api7:ai_gateway:modelcatalog/* Returns globally synchronized model catalog entries that can be used to populate AI model selections. Set compact=true to receive the reduced dropdown-oriented item shape.

Parameters

  • direction (query, string, optional): Order to list the resources by. The sorting index follows the configuration of order_by.
  • page_size (query, integer, optional): Number of resources listed per page. Used together with page. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.
  • page (query, integer, optional): Page number of the listed resources. Used together with page_size. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.
  • search (query, string, optional): Condition to search resources by.
  • order_by (query, string, optional): Field used to order catalog entries.
  • provider (query, string, optional): Filter catalog entries by canonical provider.
  • status (query, string, optional): Filter catalog entries by status.
  • compact (query, boolean, optional): Return the compact dropdown-oriented item shape when true.

Responses

  • 200: Successfully retrieved the paginated model catalog.
  • allOf variant 1
  • list (array, optional): An array of resources.
  • total (integer, optional): Total number of objects.
  • allOf variant 2
  • list (array, optional): An array of model catalog items. When compact=true, each item uses the compact shape.
  • oneOf variant 1
  • list[].id (string, optional): The object ID.
  • list[].provider (string, optional): Canonical provider identifier used by AI model selection.
  • list[].model (string, optional): Upstream model identifier as returned by the source.
  • list[].name (string, optional): Human-readable model name from the upstream source.
  • list[].status (string, optional): Current status of the catalog entry.
  • list[].source (object,null, optional): Flattened upstream model object plus provider, preserving source fidelity for troubleshooting.
  • list[].source.provider (string, optional):
  • list[].created_at (integer, optional): The object created timestamp.
  • list[].updated_at (integer, optional): The object updated timestamp.
  • oneOf variant 2
  • list[].id (string, optional): The object ID.
  • list[].provider (string, optional): Canonical provider identifier used by AI model selection.
  • list[].model (string, optional): Upstream model identifier as stored from the source; it may include a provider-like prefix segment.
  • list[].name (string, optional): Human-readable model name from the upstream source.
  • 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.

cURL

curl -X GET '$API_BASE_URL/api/model_catalogs'

File

Previous Page

Trigger a manual model catalog sync

Next Page