Method: models.list

Full name: projects.locations.models.list

Lists Models in a Location.

Endpoint

gethttps://{service-endpoint}/v1/{parent}/models

Where{service-endpoint} is one of thesupported service endpoints.

Path parameters

parentstring

Required. The resource name of the Location to list the Models from. Format:projects/{project}/locations/{location}

Query parameters

filterstring

An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • model supports = and !=.model represents the Model id, i.e. the last segment of the Model'sresource name.
  • displayName supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • `labels.key:* or labels:key - key existence
    • A key including a space must be quoted.labels."a key".
  • base_model_name only supports =

Some examples:

  • model=1234
  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison"
pageSizeinteger

The standard list page size.

pageTokenstring

The standard list page token. Typically obtained viaListModelsResponse.next_page_token of the previousModelService.ListModels call.

readMaskstring (FieldMask format)

Mask specifying which fields to read.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

orderBystring

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • displayName
  • createTime
  • updateTime

Example:displayName, createTime desc.

Request body

The request body must be empty.

Response body

Response message forModelService.ListModels

If successful, the response body contains data with the following structure:

Fields
models[]object (Model)

List of Models in the requested page.

nextPageTokenstring

A token to retrieve next page of results. Pass toListModelsRequest.page_token to obtain that page.

JSON representation
{"models":[{object (Model)}],"nextPageToken":string}

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-27 UTC.