Fetch child Assets | Frame.io API Documentation

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

[
  {
    "account_id": "a3f1c2d4-5678-4e9b-9f12-3456789abcde",
    "archive_from": "2024-01-15T09:30:00Z",
    "archive_scheduled_at": "2024-01-20T09:30:00Z",
    "archive_status": "scheduled",
    "archived_at": "2024-01-25T09:30:00Z",
    "asset_type": "document",
    "bundle": false,
    "bundle_view": "grid",
    "cover_asset_id": "b7e9f8d2-1234-4a56-8cde-9876543210ab",
    "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": false,
      "mfa_enforced_at": "2023-11-01T12:00:00Z",
      "email": "jane.doe@example.com",
      "name": "Jane Doe",
      "image_64": "https://cdn.frame.io/images/users/64/user123.png",
      "timezone_value": "America/Los_Angeles",
      "account_id": "a3f1c2d4-5678-4e9b-9f12-3456789abcde",
      "updated_at": "2024-04-10T15:45:00Z",
      "image_256": "https://cdn.frame.io/images/users/256/user123.png",
      "_type": "user",
      "user_hash": "hash_abc123xyz",
      "upload_url": "https://upload.frame.io/user123",
      "profile_image": "https://cdn.frame.io/images/users/profile/user123.png",
      "first_login_at": "2022-05-20T08:00:00Z",
      "joined_via": "email_invite",
      "id": "user-1234-5678-9012-3456",
      "next_digest_date": "2024-04-17T08:00:00Z",
      "last_seen": "2024-04-15T18:30:00Z",
      "inserted_at": "2022-05-20T08:00:00Z",
      "from_adobe": false,
      "avatar_color": "#4A90E2",
      "highest_account_role": "admin",
      "integrations": [
        "slack",
        "dropbox"
      ],
      "roles": {
        "admin": true,
        "id": "role-001",
        "sales": false,
        "support": true,
        "service_desk": false
      },
      "user_default_color": "#FF5733"
    },
    "frames": 2400,
    "hard_deleted_at": null,
    "id": "c9d8e7f6-1234-4b56-8cde-1234567890ab",
    "index": 2.5,
    "is_bundle_child": false,
    "is_hls_required": true,
    "is_session_watermarked": false,
    "item_count": 12,
    "label": "in_progress",
    "metadata": {
      "camera": "RED Komodo",
      "location": "Los Angeles Studio"
    },
    "metadata_flags": {
      "id": "meta-1234-5678-9012-3456",
      "is_360": false,
      "is_hdr": true,
      "is_original_player_compatible": true
    },
    "name": "Project_Script_v2.pdf",
    "original": "https://cdn.frame.io/originals/c9d8e7f6-1234-4b56-8cde-1234567890ab.pdf",
    "parent_asset_id": "eefb57e0-79f2-4bc7-9b70-99fbc175175c",
    "project_id": "proj-9876-5432-10ab-cdef",
    "properties": {
      "scene": "5",
      "take": "3"
    },
    "required_transcodes": {
      "cover": false,
      "finalized": [
        "thumb",
        "h264_720",
        "image_high"
      ],
      "h264_1080_best": false,
      "h264_2160": false,
      "h264_360": true,
      "h264_540": false,
      "h264_720": true,
      "image_full": true,
      "image_high": true,
      "page_proxy": false,
      "thumb": true,
      "thumb_540": false,
      "thumb_orig_ar_540": false,
      "thumb_scrub": true
    },
    "team_id": "team-4567-8901-2345-6789",
    "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
  }
]

Get child elements of a given asset. Can be used to get the items in a review link, version stack, folder, as well as including an asset to use on the cover of a folder.

Authentication

AuthorizationBearer

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

Path parameters

asset_idstringRequiredformat: "uuid"

Query parameters

include_deletedbooleanOptionalDefaults to false

Include deleted files by passing true

includeenumOptional

Include additional “pre-loads” for related resources

Allowed values:

sortenumOptional

The sorting order for the returned list of Assets. Supporting chaining like comment_count,id. Also supports reversing the order with - i.e. -comment_count,id or filetype,-id.

pagedoubleOptional

The current page number in this Paginated Response

page_sizedoubleOptional

Number of pages in this Paginated Response

Response headers

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

Response

Assets success response

object

Errors

401

Unauthorized Error

404

Not Found Error

1	import requests
2
3	url = "https://api.frame.io/v2/assets/asset_id/children"
4
5	payload = {}
6	headers = {
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.get(url, json=payload, headers=headers)
12
13	print(response.json())

1	[
2	{
3	"account_id": "a3f1c2d4-5678-4e9b-9f12-3456789abcde",
4	"archive_from": "2024-01-15T09:30:00Z",
5	"archive_scheduled_at": "2024-01-20T09:30:00Z",
6	"archive_status": "scheduled",
7	"archived_at": "2024-01-25T09:30:00Z",
8	"asset_type": "document",
9	"bundle": false,
10	"bundle_view": "grid",
11	"cover_asset_id": "b7e9f8d2-1234-4a56-8cde-9876543210ab",
12	"creator": {
13	"digest_frequency": "weekly",
14	"image_32": "https://cdn.frame.io/images/users/32/user123.png",
15	"image_128": "https://cdn.frame.io/images/users/128/user123.png",
16	"from_google": false,
17	"mfa_enforced_at": "2023-11-01T12:00:00Z",
18	"email": "jane.doe@example.com",
19	"name": "Jane Doe",
20	"image_64": "https://cdn.frame.io/images/users/64/user123.png",
21	"timezone_value": "America/Los_Angeles",
22	"account_id": "a3f1c2d4-5678-4e9b-9f12-3456789abcde",
23	"updated_at": "2024-04-10T15:45:00Z",
24	"image_256": "https://cdn.frame.io/images/users/256/user123.png",
25	"_type": "user",
26	"user_hash": "hash_abc123xyz",
27	"upload_url": "https://upload.frame.io/user123",
28	"profile_image": "https://cdn.frame.io/images/users/profile/user123.png",
29	"first_login_at": "2022-05-20T08:00:00Z",
30	"joined_via": "email_invite",
31	"id": "user-1234-5678-9012-3456",
32	"next_digest_date": "2024-04-17T08:00:00Z",
33	"last_seen": "2024-04-15T18:30:00Z",
34	"inserted_at": "2022-05-20T08:00:00Z",
35	"from_adobe": false,
36	"avatar_color": "#4A90E2",
37	"highest_account_role": "admin",
38	"integrations": [
39	"slack",
40	"dropbox"
41	],
42	"roles": {
43	"admin": true,
44	"id": "role-001",
45	"sales": false,
46	"support": true,
47	"service_desk": false
48	},
49	"user_default_color": "#FF5733"
50	},
51	"frames": 2400,
52	"hard_deleted_at": null,
53	"id": "c9d8e7f6-1234-4b56-8cde-1234567890ab",
54	"index": 2.5,
55	"is_bundle_child": false,
56	"is_hls_required": true,
57	"is_session_watermarked": false,
58	"item_count": 12,
59	"label": "in_progress",
60	"metadata": {
61	"camera": "RED Komodo",
62	"location": "Los Angeles Studio"
63	},
64	"metadata_flags": {
65	"id": "meta-1234-5678-9012-3456",
66	"is_360": false,
67	"is_hdr": true,
68	"is_original_player_compatible": true
69	},
70	"name": "Project_Script_v2.pdf",
71	"original": "https://cdn.frame.io/originals/c9d8e7f6-1234-4b56-8cde-1234567890ab.pdf",
72	"parent_asset_id": "eefb57e0-79f2-4bc7-9b70-99fbc175175c",
73	"project_id": "proj-9876-5432-10ab-cdef",
74	"properties": {
75	"scene": "5",
76	"take": "3"
77	},
78	"required_transcodes": {
79	"cover": false,
80	"finalized": [
81	"thumb",
82	"h264_720",
83	"image_high"
84	],
85	"h264_1080_best": false,
86	"h264_2160": false,
87	"h264_360": true,
88	"h264_540": false,
89	"h264_720": true,
90	"image_full": true,
91	"image_high": true,
92	"page_proxy": false,
93	"thumb": true,
94	"thumb_540": false,
95	"thumb_orig_ar_540": false,
96	"thumb_scrub": true
97	},
98	"team_id": "team-4567-8901-2345-6789",
99	"user_permissions": {
100	"can_download": true,
101	"can_modify_template": false,
102	"can_public_share_presentation": true,
103	"can_public_share_review_link": true,
104	"can_share_downloadable_presentation": false,
105	"can_share_downloadable_review_link": true,
106	"can_share_unwatermarked_presentation": false,
107	"can_share_unwatermarked_review_link": true
108	},
109	"type": "file",
110	"view_count": 152
111	}
112	]