Type Alias GetCustomModelsParams

type GetCustomModelsParams = {
    limit?: string;
    publishedState?: FireflyApiClient.GetCustomModelsPublishedState;
    sortBy?: FireflyApiClient.GetCustomModelsSortBy;
    start?: string;
}

Index

Properties

limit? publishedState? sortBy? start?

Properties

`Optional` `Minimum` `Maximum`limit

limit?: string

The number of custom models to return in a paginated response. 1 50

`Optional`publishedState

publishedState?: FireflyApiClient.GetCustomModelsPublishedState

This filters custom models by published state.

`Optional`sortBy

sortBy?: FireflyApiClient.GetCustomModelsSortBy

A sorting option for the response list. For a reverse sort, use - (e.g., -modifiedDate). Multi-vector sorting is not currently supported.

`Optional`start

start?: string

The first result to include in a paginated response. Required if a limit is specified.