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": "a3f1c9e2-4b7d-4f8a-9c3e-2d5f7b6a9e1c",
    "archive_from": "2024-01-15T09:30:00Z",
    "archive_scheduled_at": "2024-01-15T09:30:00Z",
    "archive_status": "pending",
    "archived_at": "2024-01-15T09:30:00Z",
    "asset_type": "document",
    "bundle": false,
    "bundle_view": "default",
    "cover_asset_id": "b7d9f8a3-1c4e-4a7b-9c3e-2d5f7b6a9e1d",
    "creator": {
      "digest_frequency": "weekly",
      "image_32": "https://cdn.frame.io/images/users/32/user123.png",
      "image_128": "https://cdn.frame.io/images/users/128/user123.png",
      "from_google": true,
      "mfa_enforced_at": "2023-11-01T08:00:00Z",
      "email": "jane.doe@example.com",
      "name": "Jane Doe",
      "image_64": "https://cdn.frame.io/images/users/64/user123.png",
      "timezone_value": "America/New_York",
      "account_id": "a3f1c9e2-4b7d-4f8a-9c3e-2d5f7b6a9e1c",
      "updated_at": "2024-04-10T12:00:00Z",
      "image_256": "https://cdn.frame.io/images/users/256/user123.png",
      "_type": "user",
      "user_hash": "abc123def456ghi789",
      "upload_url": "https://upload.frame.io/user123",
      "profile_image": "https://cdn.frame.io/images/users/profile/user123.png",
      "first_login_at": "2022-05-15T09:00:00Z",
      "joined_via": "email_invite",
      "id": "user-1234abcd-5678-efgh-9012-ijklmnopqrst",
      "next_digest_date": "2024-04-17T08:00:00Z",
      "last_seen": "2024-04-12T16:45:00Z",
      "inserted_at": "2022-05-15T09:00:00Z",
      "from_adobe": false,
      "avatar_color": "#4A90E2",
      "highest_account_role": "admin",
      "integrations": [
        "slack",
        "dropbox"
      ],
      "roles": {
        "admin": true,
        "id": "role-5678abcd-1234-efgh-9012-ijklmnopqrst",
        "sales": false,
        "support": true,
        "service_desk": false
      },
      "user_default_color": "#FF5733"
    },
    "frames": 2400,
    "hard_deleted_at": "2024-02-14T09:30:00Z",
    "id": "asset-9f8a7b6c-5d4e-3f2a-1b0c-9d8e7f6a5b4c",
    "index": 12.5,
    "is_bundle_child": false,
    "is_hls_required": true,
    "is_session_watermarked": false,
    "item_count": 15,
    "label": "approved",
    "metadata": {},
    "metadata_flags": {
      "id": "meta-1234abcd-5678-efgh-9012-ijklmnopqrst",
      "is_360": false,
      "is_hdr": true,
      "is_original_player_compatible": true
    },
    "name": "Project Proposal Document.pdf",
    "original": "https://cdn.frame.io/assets/originals/project-proposal.pdf",
    "parent_asset_id": "folder-1a2b3c4d-5e6f-7g8h-9i0j-k1l2m3n4o5p6",
    "project_id": "project-1234abcd-5678-efgh-9012-ijklmnopqrst",
    "properties": {
      "": "Confidential"
    },
    "required_transcodes": {
      "cover": true,
      "finalized": [
        "thumb",
        "image_full",
        "h264_720"
      ],
      "h264_1080_best": true,
      "h264_2160": false,
      "h264_360": true,
      "h264_540": true,
      "h264_720": true,
      "image_full": true,
      "image_high": true,
      "page_proxy": true,
      "thumb": true,
      "thumb_540": false,
      "thumb_orig_ar_540": false,
      "thumb_scrub": true
    },
    "team_id": "team-9876zyxw-vuts-rqpo-nmlk-jihgfedcba09",
    "user_permissions": {
      "can_download": true,
      "can_modify_template": false,
      "can_public_share_presentation": true,
      "can_public_share_review_link": true,
      "can_share_downloadable_presentation": false,
      "can_share_downloadable_review_link": true,
      "can_share_unwatermarked_presentation": false,
      "can_share_unwatermarked_review_link": true
    },
    "type": "file",
    "view_count": 152
  }
]

Search using ElasticSearch key/value pairs

認証

AuthorizationBearer

Bearer <token>形式のBearer認証。tokenは認証トークンです。

リクエスト

Advanced asset search

account_idstringオプション形式: "uuid"

filterobjectオプション

Custom ES filters to apply to your query

include_deletedbooleanオプション

Flag to include soft-deleted records in results

optsobjectオプション

Additional request options

pageintegerオプション

The page to retrieve

page_sizeintegerオプション

The number of results to include in the page

qstringオプション

Search text

querystringオプション

Search text

sortstringオプション

Sorting parameters

レスポンスヘッダー

linkstring

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

レスポンス

Assets success response

object

エラー

401

Unauthorized Error