Skip to main content
The Model Releases API allows you to create, retrieve, and list model releases. A model release represents a specific release of a model within a model suite.

​
Resource

​
ModelRelease

​
name
string
required
Resource name with pattern modelProviders/{model_provider}/modelSuites/{model_suite}/modelReleases/{model_release}
​
create_time
Timestamp
When the ModelRelease was created
​
population
string
required
The Population resource this ModelRelease references.Format: dataProviders/{data_provider}/populations/{population}This field is immutable after creation.

​
Methods

​
CreateModelRelease

Creates a new ModelRelease.
​
parent
string
required
Resource name of the parent ModelSuite.Format: modelProviders/{model_provider}/modelSuites/{model_suite}
​
model_release
ModelRelease
required
The ModelRelease to create. The name field will be ignored, and the system will assign an ID.Required fields:
  • population: Reference to a Population resource
Response Returns the created ModelRelease resource. Example Request 
CreateModelReleaseRequest {
  parent: "modelProviders/123/modelSuites/456"
  model_release: {
    population: "dataProviders/789/populations/101"
  }
}

​
GetModelRelease

Returns a single ModelRelease.
​
name
string
required
Resource name of the ModelRelease to retrieve.Format: modelProviders/{model_provider}/modelSuites/{model_suite}/modelReleases/{model_release}
Response Returns a ModelRelease resource. Example Request 
GetModelReleaseRequest {
  name: "modelProviders/123/modelSuites/456/modelReleases/789"
}

​
ListModelReleases

Lists ModelRelease resources.
​
parent
string
required
Resource name of the parent ModelSuite.Format: modelProviders/{model_provider}/modelSuites/{model_suite}The wildcard ID (-) may be used in place of the ModelSuite ID to list across every ModelSuite in the ancestor ModelProvider.
​
filter
Filter
Structured filter criteria. Each field represents a term in a conjunction.
​
filter.population_in
string[]
Set of Population resource names which ModelRelease.population must be in.Format: dataProviders/{data_provider}/populations/{population}
​
page_size
int32
The maximum number of ModelReleases to return. The service may return fewer than this value.
  • If unspecified, at most 50 ModelReleases will be returned
  • Maximum value is 1000; values above 1000 will be coerced to 1000
​
page_token
string
A page token received from a previous ListModelReleases call. Provide this to retrieve the subsequent page.When paginating, all other parameters must match the call that provided the page token.
Response
​
model_releases
ModelRelease[]
List of ModelRelease resources
​
next_page_token
string
A token that can be sent as page_token to retrieve the next page. If omitted, there are no subsequent pages.
Example Request 
ListModelReleasesRequest {
  parent: "modelProviders/123/modelSuites/456"
  filter: {
    population_in: [
      "dataProviders/789/populations/101",
      "dataProviders/789/populations/102"
    ]
  }
  page_size: 50
}

Build docs developers (and LLMs) love

Get started for freeTalk to us