Search for Assets

Search for Assets via query parameters

SecurityJWT or OAuth2 or DeveloperToken

Request

query Parameters

account_id	string <uuid>
filter	object Custom ES filters to apply to your query
include	string
include_deleted	boolean Flag to include soft-deleted records in results
opts	object Additional request options
page	integer The page to retrieve
page_size	integer The number of results to include in the page
project_id	string <uuid>
properties	object
q	string Search text
query	string Search text
shared_projects	boolean
sort	string Sorting parameters
	string or Array of strings
type	string

Responses

200

Assets success response

Response Headers
link	string Pagination links
page-number	integer Current page of results
per-page	integer Number of entries per page
total	integer Total entries across all pagess
total-pages	integer Number of pages

Response Schema: application/json

Array

account_id	string <uuid> Account ID this asset belongs to
archive_from	string or null <date-time>
archive_scheduled_at	string or null <date-time>
archive_status	string or null
archived_at	string or null <date-time>
asset_type	string Enum: "document" "image" "stream"
bundle	boolean Deprecated
bundle_view	string Deprecated
cover_asset_id	string <uuid>
	object (User) User model
frames	integer The number of frames in this asset (really only useful for videos)
hard_deleted_at	string or null <date-time> Indicates the datetime this asset was hard deleted (30 days after soft-deletion)
id	string <uuid> The ID for this asset, can be used in places like `https://app.frame.io/player/:id` to go directly to an asset
index	number <float> Represented within the Frame.io UI as the "custom sort order" within the grid view
is_bundle_child	boolean Deprecated Indicates whether an asset is the child of a bundle asset
is_hls_required	boolean Indicates whether HLS is required to playback this asset
is_session_watermarked	boolean Indicates if this asset is subject to Session Based Watermarking (WMID)
item_count	integer Applies only to folders and version stacks, indicates the number of items in that container
	string Status of the given Asset
metadata	object
	object (MetadataFlags)
name	string Represents the name of the asset (filename)
original	string This is a URL to download the original asset, or in the event it's subject to watermarking but you still have permission to download - an asset that will be watermarked just-in-time as you download it
parent_asset_id	string <uuid> The folder that this asset is in
project_id	string <uuid> The project ID that this asset belongs to
	object Accepts arbitrary key/value pairs for storing information on an asset
	object (RequiredTranscodes)
team_id	string <uuid>
	object (UserPermissions)
type	string Enum: "file" "folder" "version_stack" "bundle"
view_count	integer Not a very helpful number, this really just represents the number of times this asset has been requested via the API

401

Unauthorized response

get/v2/search/assets

Request samples

curl
JavaScript
Node.js
Python
C#

Response samples

application/json

[{"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"archive_from": "2019-08-24T14:15:22Z",
"archive_scheduled_at": "2019-08-24T14:15:22Z",
"archive_status": "string",
"archived_at": "2019-08-24T14:15:22Z",
"asset_type": "document",
"bundle": true,
"bundle_view": "string",
"cover_asset_id": "6bd8f503-67d9-4b55-b7c3-e1b6bef82750",
"creator": {"digest_frequency": "string",
"features_seen": null,
"profile_image_original": null,
"image_32": "string",
"image_128": "string",
"from_google": true,
"mfa_enforced_at": "string",
"email": "string",
"bio": null,
"name": "string",
"image_64": "string",
"timezone_value": "string",
"account_id": "string",
"updated_at": "string",
"image_256": "string",
"_type": "string",
"user_hash": "string",
"context": null,
"upload_url": "string",
"location": null,
"phone": null,
"deleted_at": null,
"profile_image": "string",
"first_login_at": "string",
"joined_via": "string",
"email_confirm_by": null,
"id": "string",
"next_digest_date": "string",
"email_preferences": null,
"last_seen": "string",
"inserted_at": "string",
"roles": {"admin": true,
"id": "string",
"sales": true,
"support": true
},
"user_default_color": "string"
},
"frames": 0,
"hard_deleted_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"index": 0,
"is_bundle_child": true,
"is_hls_required": true,
"is_session_watermarked": true,
"item_count": 0,
"label": "approved",
"metadata": { },
"metadata_flags": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_360": true,
"is_hdr": true,
"is_original_player_compatible": true
},
"name": "string",
"original": "string",
"parent_asset_id": "a7612734-1419-43cf-9bc9-c7901ea79e60",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"properties": {"": "string"
},
"required_transcodes": {"cover": true,
"finalized": ["thumb"
],
"h264_1080_best": true,
"h264_2160": true,
"h264_360": true,
"h264_540": true,
"h264_720": true,
"image_full": true,
"image_high": true,
"page_proxy": true,
"thumb": true,
"thumb_540": true,
"thumb_orig_ar_540": true,
"thumb_scrub": true
},
"team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",
"user_permissions": {"can_download": true,
"can_modify_template": true,
"can_public_share_presentation": true,
"can_public_share_review_link": true,
"can_share_downloadable_presentation": true,
"can_share_downloadable_review_link": true,
"can_share_unwatermarked_presentation": true,
"can_share_unwatermarked_review_link": true
},
"type": "file",
"view_count": 0
}
]

Search for Assets

query Parameters

Response Schema: application/json

Overview

Integrations

Company

Support