listAll* variant yields items across every page. The other variant returns one page with pagination metadata. See Pagination.
Signature
Method signatures onclient.models:
Parameters
listAll()
string
required
Project ID with prefix
pp..number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.
listPage()
string
required
Project ID with prefix
pp..number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.
Returns
listAll() result
AsyncGenerator<Model>
Yields one item at a time. The fields below describe each yielded item.
A project-owned logical Model containing immutable versions.
ModelId
required
Model ID with prefix
mdl..ProjectId
required
Project ID with prefix
pp..string
required
Name of the model.
string | null
required
Description of the model, or null when none was provided.
BaseModelId
required
The stable product identifier of a catalog base model.
string | null
required
Time the model was archived, as an ISO 8601 timestamp, or null while it is active.
string
required
Time the model was created, as an ISO 8601 timestamp.
string
required
Time the model was last updated, as an ISO 8601 timestamp.
listPage() result
Promise<{ models: Model[]; pagination: Pagination }>
Model[]
required
Models in this page.
Pagination
required
Pagination information for this page.
Errors
HTTP errors throwPotatoApiError. The endpoint documents these error responses:
HTTP endpoint:
GET /projects/{projectId}/models.