2024-01-26
▼ ▲ poly.users.likedassets.list
Parameter Order: name
Parameters:
orderBy
Description: Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which ranks assets based on how recently they were liked.
Location: query
Type: string
format
Description: Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.
Location: query
Type: string
pageToken
Type: string
Location: query
Description: Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.
name
Description: A valid user id. Currently, only the special value 'me', representing the currently-authenticated user is supported. To use 'me', you must pass an OAuth token with the request.
Location: path
Pattern: ^users/[^/]+$
Required: Yes
Type: string
pageSize
Description: The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.
Type: integer
Location: query
Format: int32
Flat Path: v1/users/{usersId}/likedassets
HTTP Method: GET
Path: v1/{+name}/likedassets
Description: Lists assets that the user has liked. Only the value 'me', representing the currently-authenticated user, is supported. May include assets with an access level of UNLISTED.
▼ ▲ poly.users.assets.list
Path: v1/{+name}/assets
Flat Path: v1/users/{usersId}/assets
Parameters:
pageSize
Description: The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.
Format: int32
Type: integer
Location: query
pageToken
Type: string
Description: Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.
Location: query
orderBy
Description: Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a combination of popularity and other features.
Location: query
Type: string
visibility
Location: query
Enum Descriptions:
Type: string
Enum:
Description: The visibility of the assets to be returned. Defaults to VISIBILITY_UNSPECIFIED which returns all assets.
name
Type: string
Description: A valid user id. Currently, only the special value 'me', representing the currently-authenticated user is supported. To use 'me', you must pass an OAuth token with the request.
Location: path
Required: Yes
Pattern: ^users/[^/]+$
format
Type: string
Location: query
Description: Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.
Parameter Order: name
Description: Lists assets authored by the given user. Only the value 'me', representing the currently-authenticated user, is supported. May include assets with an access level of PRIVATE or UNLISTED and assets which are All Rights Reserved for the currently-authenticated user.
HTTP Method: GET
▼ ▲ poly.assets.list
Flat Path: v1/assets
Description: Lists all public, remixable assets. These are assets with an access level of PUBLIC and published under the CC-By license.
Parameters:
pageToken
Type: string
Description: Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.
Location: query
maxComplexity
Enum:
Location: query
Enum Descriptions:
Description: Returns assets that are of the specified complexity or less. Defaults to COMPLEX. For example, a request for MEDIUM assets also includes SIMPLE assets.
Type: string
curated
Type: boolean
Location: query
Description: Return only assets that have been curated by the Poly team.
format
Type: string
Location: query
Description: Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.
keywords
Type: string
Location: query
Description: One or more search terms to be matched against all text that Poly has indexed for assets, which includes display_name, description, and tags. Multiple keywords should be separated by spaces.
orderBy
Type: string
Location: query
Description: Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a combination of popularity and other features.
category
Description: Filter assets based on the specified category. Supported values are: `animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, `scenes`, `technology`, and `transport`.
Type: string
Location: query
pageSize
Location: query
Type: integer
Description: The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.
Format: int32
HTTP Method: GET
Path: v1/assets
▼ ▲ poly.assets.get
Flat Path: v1/assets/{assetsId}
Parameters:
name
Type: string
Pattern: ^assets/[^/]+$
Location: path
Description: Required. An asset's name in the form `assets/{ASSET_ID}`.
Required: Yes
HTTP Method: GET
Parameter Order: name
Description: Returns detailed information about an asset given its name. PRIVATE assets are returned only if the currently authenticated user (via OAuth token) is the author of the asset.
Path: v1/{+name}