Search for Assets | Frame.io API Documentation

1 import requests 2 3 url = "https://api.frame.io/v2/search/assets" 4 5 response = requests.get(url) 6 7 print(response.json())

1 [ 2 { 3 "account_id": "string", 4 "archive_from": "2024-01-15T09:30:00Z", 5 "archive_scheduled_at": "2024-01-15T09:30:00Z", 6 "archive_status": "string", 7 "archived_at": "2024-01-15T09:30:00Z", 8 "asset_type": "document", 9 "bundle": true, 10 "bundle_view": "string", 11 "cover_asset_id": "string", 12 "creator": { 13 "digest_frequency": "string", 14 "image_32": "string", 15 "image_128": "string", 16 "from_google": true, 17 "mfa_enforced_at": "string", 18 "email": "string", 19 "name": "string", 20 "image_64": "string", 21 "timezone_value": "string", 22 "account_id": "string", 23 "updated_at": "string", 24 "image_256": "string", 25 "_type": "string", 26 "user_hash": "string", 27 "upload_url": "string", 28 "profile_image": "string", 29 "first_login_at": "string", 30 "joined_via": "string", 31 "id": "string", 32 "next_digest_date": "string", 33 "last_seen": "string", 34 "inserted_at": "string", 35 "roles": { 36 "admin": true, 37 "id": "string", 38 "sales": true, 39 "support": true 40 }, 41 "user_default_color": "string" 42 }, 43 "frames": 1, 44 "hard_deleted_at": "2024-01-15T09:30:00Z", 45 "id": "string", 46 "index": 1.1, 47 "is_bundle_child": true, 48 "is_hls_required": true, 49 "is_session_watermarked": true, 50 "item_count": 1, 51 "label": "string", 52 "metadata": {}, 53 "metadata_flags": { 54 "id": "string", 55 "is_360": true, 56 "is_hdr": true, 57 "is_original_player_compatible": true 58 }, 59 "name": "string", 60 "original": "string", 61 "parent_asset_id": "string", 62 "project_id": "string", 63 "properties": { 64 "": "string" 65 }, 66 "required_transcodes": { 67 "cover": true, 68 "finalized": [ 69 "thumb" 70 ], 71 "h264_1080_best": true, 72 "h264_2160": true, 73 "h264_360": true, 74 "h264_540": true, 75 "h264_720": true, 76 "image_full": true, 77 "image_high": true, 78 "page_proxy": true, 79 "thumb": true, 80 "thumb_540": true, 81 "thumb_orig_ar_540": true, 82 "thumb_scrub": true 83 }, 84 "team_id": "string", 85 "user_permissions": { 86 "can_download": true, 87 "can_modify_template": true, 88 "can_public_share_presentation": true, 89 "can_public_share_review_link": true, 90 "can_share_downloadable_presentation": true, 91 "can_share_downloadable_review_link": true, 92 "can_share_unwatermarked_presentation": true, 93 "can_share_unwatermarked_review_link": true 94 }, 95 "type": "file", 96 "view_count": 1 97 } 98 ]

Search for Assets via query parameters

Query parameters

account_idstringOptionalformat: "uuid"

filterobjectOptional

Custom ES filters to apply to your query

includestringOptional

include_deletedbooleanOptional

Flag to include soft-deleted records in results

optsobjectOptional

Additional request options

pageintegerOptional

The page to retrieve

page_sizeintegerOptional

The number of results to include in the page

project_idstringOptionalformat: "uuid"

propertiesobjectOptional

qstringOptional

Search text

querystringOptional

Search text

shared_projectsbooleanOptional

sortstringOptional

Sorting parameters

team_idstring or list of stringsOptional

typestringOptional

Response

Assets success response

object

Query parameters

Response

Errors