Get files (bulk)

POST

https://api.frame.io/v4/accounts/:account_id/files/bulk_get

POST

/v4/accounts/:account_id/files/bulk_get

1 from frameio_experimental import FrameioExperimental
2 from frameio_experimental.files import BulkFileGetParamsData
3 
4 client = FrameioExperimental(
5     token="YOUR_TOKEN_HERE",
6 )
7 
8 client.files.bulk_get(
9     account_id="2ddba34d-fb51-4800-86f5-c5ab61fa487d",
10     include="media_links.original",
11     api_version="experimental",
12     data=BulkFileGetParamsData(
13         file_ids=[
14             "2d6a081c-300b-48c9-87f1-ef5d90ce466e",
15             "b6653116-61d6-40fb-acff-4b22fda0e4d4"
16         ],
17     ),
18 )

1 {
2   "data": [
3     {
4       "id": "018f3c2a-0000-0000-0000-000000000001",
5       "status": 200,
6       "file": {
7         "file_size": 1137444,
8         "id": "063a0dbd-f98e-478a-b75b-ecef21736b1c",
9         "media_type": "image/png",
10         "name": "asset.png",
11         "status": "created",
12         "created_at": "2023-09-25T19:18:29.614189Z",
13         "parent_id": "9142af45-e874-4fba-bc3a-029d45eebf93",
14         "project_id": "66d950ae-ab23-4e85-8d00-1afac092c47e",
15         "type": "file",
16         "updated_at": "2024-02-07T16:44:41.986478Z",
17         "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c",
18         "adobe_version_id": "2",
19         "media_links": {
20           "high_quality": {
21             "download_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN"
22           },
23           "original": {
24             "download_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
25             "inline_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=inline%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragSDFXDFh&1Key-Pair-Id=KKI497NESTHMN"
26           },
27           "thumbnail": {
28             "download_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
29             "url": "https://picture2.frame.io/image/s3://frameio-assets-development/image/cd58cb8e-24b3-4498-8d0f-9532fcd04d11/image_full.png?alg=HS256&sig=0_u7w_wz2MwQHOXp000ibbQSMRijujyaUu8V3YYPxu4&exp=1729857600"
30           }
31         },
32         "adobe_id": "urn:aaid:sc:US:a1b2c3d4-e5f6-7890-abcd-ef1234567890",
33         "creator": {
34           "active": true,
35           "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
36           "email": "user_email@example.com",
37           "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
38           "name": "Jon Doe"
39         },
40         "metadata": [
41           {
42             "field_type": "select",
43             "field_definition_id": "8fb17fb6-f32f-45e2-bfe3-c81bb75ddcee",
44             "field_definition_name": "Fields definition name",
45             "mutable": true,
46             "value": [
47               {
48                 "display_name": "Display name",
49                 "id": "03f89c79-f5ca-48e8-b4f7-208520126847"
50               }
51             ],
52             "field_options": [
53               {
54                 "display_name": "Display name",
55                 "id": "03f89c79-f5ca-48e8-b4f7-208520126847"
56               },
57               {
58                 "display_name": "Display name 2",
59                 "id": "7f9a8b14-4b45-4d62-87b6-f74bafeaa97e"
60               }
61             ]
62           }
63         ],
64         "project": {
65           "created_at": "2024-01-25T19:18:29.614189Z",
66           "id": "94638bd5-5d6f-49f0-8e57-e597e0bca7d2",
67           "name": "My Project",
68           "root_folder_id": "7ab5d6b7-2cb5-45ac-9656-16c4beb37760",
69           "status": "active",
70           "storage": 15000,
71           "updated_at": "2024-02-07T16:44:41.986478Z",
72           "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/",
73           "workspace_id": "e4e1c2f7-4a9a-4fec-b126-0bc6d8c51a80",
74           "description": "Project Description",
75           "adobe_id": "urn:aaid:sc:US:9f4e4d7a-4b6b-4c4f-9f00-b31a91cfc6f3",
76           "restricted": false,
77           "owner": {
78             "active": true,
79             "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
80             "email": "user_email@example.com",
81             "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
82             "name": "Jon Doe"
83           }
84         }
85       }
86     },
87     {
88       "id": "018f3c2a-0000-0000-0000-000000000002",
89       "status": 404,
90       "error": {
91         "detail": "File not found",
92         "title": "Not Found"
93       }
94     },
95     {
96       "id": "adobe:urn:aaid:sc:VA6C2:00000000-0000-0000-0000-000000000003",
97       "status": 403,
98       "error": {
99         "detail": "You do not have permission to view this file.",
100         "title": "Forbidden"
101       }
102     }
103   ]
104 }

Fetch details for a known set of files in a single request, returning partial results.
Between 1 and 50 unique file IDs may be provided. Each ID may be a Frame.io UUID or an adobe:-prefixed Adobe ID.
All files must belong to the same project; a request spanning multiple projects fails with 422.
Rate Limits: 60 calls per 1.00 minute(s) per account_user

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequired

A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be prefixed with adobe: (e.g. adobe:<adobe_org_id> for an account, adobe:<adobe_asset_id> for a project or folder, adobe:adobe:<adobe_asset_id>|<version>` for a file asset).

A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be prefixed with `adobe:` (e.g. `adobe:<adobe_org_id>` for an account, `adobe:<adobe_asset_id>` for a project or folder, `adobe:`adobe:<adobe_asset_id>|<version>` for a file asset).

Query parameters

includeenumOptional

Supported include query parameter values for endpoints that return files with media links

Request

Request body

dataobjectRequired

Response headers

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

Response

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error