Advanced search for Assets | Frame.io API Documentation

import requests
url = "https://api.frame.io/v2/search/library"
payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

[
  {
    "account_id": "string",
    "archive_from": "2024-01-15T09:30:00Z",
    "archive_scheduled_at": "2024-01-15T09:30:00Z",
    "archive_status": "string",
    "archived_at": "2024-01-15T09:30:00Z",
    "asset_type": "document",
    "bundle": true,
    "bundle_view": "string",
    "cover_asset_id": "string",
    "creator": {
      "digest_frequency": "string",
      "image_32": "string",
      "image_128": "string",
      "from_google": true,
      "mfa_enforced_at": "string",
      "email": "string",
      "name": "string",
      "image_64": "string",
      "timezone_value": "string",
      "account_id": "string",
      "updated_at": "string",
      "image_256": "string",
      "_type": "string",
      "user_hash": "string",
      "upload_url": "string",
      "profile_image": "string",
      "first_login_at": "string",
      "joined_via": "string",
      "id": "string",
      "next_digest_date": "string",
      "last_seen": "string",
      "inserted_at": "string",
      "from_adobe": true,
      "avatar_color": "string",
      "highest_account_role": "string",
      "integrations": [
        "string"
      ],
      "roles": {
        "admin": true,
        "id": "string",
        "sales": true,
        "support": true,
        "service_desk": true
      },
      "user_default_color": "string"
    },
    "frames": 1,
    "hard_deleted_at": "2024-01-15T09:30:00Z",
    "id": "string",
    "index": 1.1,
    "is_bundle_child": true,
    "is_hls_required": true,
    "is_session_watermarked": true,
    "item_count": 1,
    "label": "string",
    "metadata": {},
    "metadata_flags": {
      "id": "string",
      "is_360": true,
      "is_hdr": true,
      "is_original_player_compatible": true
    },
    "name": "string",
    "original": "string",
    "parent_asset_id": "string",
    "project_id": "string",
    "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": "string",
    "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": 1
  }
]

Search using ElasticSearch key/value pairs

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Advanced asset search

account_idstringOptionalformat: "uuid"

filterobjectOptional

Custom ES filters to apply to your query

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

qstringOptional

Search text

querystringOptional

Search text

sortstringOptional

Sorting parameters

Response headers

linkstring or null

Pagination links

page-numberinteger

Current page of results

per-pageinteger

Number of entries per page

totalinteger

Total entries across all pagess

total-pagesinteger

Number of pages

Response

Assets success response

object

Authentication

Request

Response headers

Response

Errors