adobe-firefly-sdk
    Preparing search index...

    Type Alias GetCustomModelsData

    type GetCustomModelsData = {
        body?: never;
        headers: { "x-request-id": string; "x-user-token"?: string };
        path?: never;
        query?: {
            limit?: string;
            publishedState?:
                | "all"
                | "ready"
                | "published"
                | "unpublished"
                | "queued"
                | "training"
                | "failed"
                | "cancelled";
            sortBy?: "assetName"
            | "createdDate"
            | "modifiedDate";
            start?: string;
        };
        url: "/v3/custom-models";
    }
    Index

    Properties

    body? headers path? query? url

    Properties

    Optionalbody

    body?: never
    headers: { "x-request-id": string; "x-user-token"?: string }

    Type Declaration

    • x-request-id: string

      A unique request identifier defined by you. This is used by Adobe Support to trace the request in logs. This header is automatically generated by the server if not explicitly set.

    • Optionalx-user-token?: string

      A user token referencing the user's individual account, obtained using their credentials. The user token must be preceded by Bearer.

    path?: never
    query?: {
        limit?: string;
        publishedState?:
            | "all"
            | "ready"
            | "published"
            | "unpublished"
            | "queued"
            | "training"
            | "failed"
            | "cancelled";
        sortBy?: "assetName"
        | "createdDate"
        | "modifiedDate";
        start?: string;
    }

    Type Declaration

    • Optionallimit?: string

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

    • OptionalpublishedState?:
          | "all"
          | "ready"
          | "published"
          | "unpublished"
          | "queued"
          | "training"
          | "failed"
          | "cancelled"

      This filters custom models by published state.

    • OptionalsortBy?: "assetName" | "createdDate" | "modifiedDate"

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

    • Optionalstart?: string

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

    url: "/v3/custom-models"

    Settings

    Member Visibility

    On This Page

    Properties