tenor-client
    Preparing search index...

    Interface TenorSearchOptions

    interface TenorSearchOptions {
        aspectRatioRange?: TenorAspectRatioRange;
        contentFilter?: TenorContentFilter;
        country?: string;
        limit?: number;
        locale?: `${string}${string}-${string}${string}`;
        mediaFilter?: TenorMediaFilter[];
        position?: string;
        query: string;
        random?: boolean;
        searchFilters?: TenorSearchFilter[];
    }
    Index

    Properties

    aspectRatioRange? contentFilter? country? limit? locale? mediaFilter? position? query random? searchFilters?

    Properties

    aspectRatioRange?: TenorAspectRatioRange

    Optional, but strongly recommended. Filter the Response Objects to only include GIFs with aspect ratios that fit within the selected range.

    "all"
    contentFilter?: TenorContentFilter

    Optional, but strongly recommended. The content safety level.

    "low"
    country?: string

    Optional, but strongly recommended. Country of origin for the request. Two-letter ISO 3166-1 alpha-2 country code.

    "US"
    limit?: number

    Fetch up to the specified number of results. Maximum value is 50.

    20
    locale?: `${string}${string}-${string}${string}`

    Optional, but strongly recommended. Default language to interpret the query. First two letters should be the two-letter language code according to ISO 639 Last two letters should be the two-letter ISO 3166-1 alpha-2 country code. The country code and language code should be separated by a hyphen (-)

    "en-US"
    mediaFilter?: TenorMediaFilter[]

    Optional, but strongly recomended. List of GIF formats to filter the response objects. By default, it does no filtering and returns all response objects.

    position?: string

    Retrieve results that start at the position "value". Use a non-zero, non-empty value from next, returned by the API response, to get the next set of results. It isn't an index and might be an integer, float, or string.

    query: string

    The query search string. Recommended to pass unmodified from the user.

    random?: boolean

    Specify whether to randomly order the response. When disabled, it orders the results by Tenor's relevancy ranking.

    false
    searchFilters?: TenorSearchFilter[]

    Array of non-GIF content types to filter the Response Objects. sticker returns both static and animated sticker content. sticker and -static returns only animated sticker content. sticker and static returns only static sticker content. If you only want GIF content, leave an empty array or remove this option.

    Settings

    Member Visibility

    On This Page

    Properties