Показать файл

GET

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

GET

/v4/accounts/:account_id/files/:file_id

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN_HERE",
5 )
6 
7 client.files.show(
8     account_id="1ac65329-74b2-41ac-9393-eaa4263bbaea",
9     file_id="29c50925-6246-492f-8f55-e2e9b1197c46",
10     include="media_links.original",
11 )

1 {
2   "data": {
3     "created_at": "2023-09-25T19:18:29.614189Z",
4     "file_size": 1137444,
5     "id": "b4c00e24-9beb-4c38-91ad-8f58a88f5a8a",
6     "media_type": "image/png",
7     "name": "asset.png",
8     "parent_id": "6ecaf9c3-23ab-4031-8dc8-8acbfec1afbd",
9     "project_id": "70e467b0-c8ab-4881-9c63-836664103a26",
10     "status": "created",
11     "type": "file",
12     "updated_at": "2024-02-07T16:44:41.986478Z",
13     "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c",
14     "adobe_id": "urn:aaid:sc:US:a1b2c3d4-e5f6-7890-abcd-ef1234567890",
15     "adobe_version_id": "2",
16     "creator": {
17       "active": true,
18       "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",
19       "email": "user_email@example.com",
20       "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
21       "name": "Jon Doe"
22     },
23     "media_links": {
24       "high_quality": {
25         "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"
26       },
27       "original": {
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         "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"
30       },
31       "thumbnail": {
32         "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",
33         "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"
34       }
35     },
36     "metadata": [
37       {
38         "field_type": "select",
39         "field_definition_id": "36279dd3-a607-432e-ad85-2005522b3c4e",
40         "field_definition_name": "Fields definition name",
41         "mutable": true,
42         "value": [
43           {
44             "display_name": "Display name",
45             "id": "6711d43d-b717-4765-bde4-994bf39f88df"
46           }
47         ],
48         "field_options": [
49           {
50             "display_name": "Display name",
51             "id": "6711d43d-b717-4765-bde4-994bf39f88df"
52           },
53           {
54             "display_name": "Display name 2",
55             "id": "6f10a133-919f-43f0-8e67-13efc50ba439"
56           }
57         ]
58       }
59     ],
60     "project": {
61       "created_at": "2024-01-25T19:18:29.614189Z",
62       "id": "90d3f72c-abed-463f-8d1b-1c3c084556e1",
63       "name": "My Project",
64       "root_folder_id": "a8426cb1-5056-4010-92d0-416e2c0d3a78",
65       "status": "active",
66       "storage": 15000,
67       "updated_at": "2024-02-07T16:44:41.986478Z",
68       "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/",
69       "workspace_id": "f9cc69f8-c0f8-4176-9eb1-3049c4b6b647",
70       "description": "Project Description",
71       "adobe_id": "urn:aaid:sc:US:9f4e4d7a-4b6b-4c4f-9f00-b31a91cfc6f3",
72       "restricted": false,
73       "owner": {
74         "active": true,
75         "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",
76         "email": "user_email@example.com",
77         "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
78         "name": "Jon Doe"
79       }
80     }
81   }
82 }

Показать сведения о файле.

Использовать параметр запроса “включить” для избирательного включения дополнительных свойств в ответ.

Примечание. Если вы включаете “media_links.original”, а у пользователя нет разрешения на загрузку файлов, тогда эта конечная точка ответит ошибкой “403 запрещено”. Если контент недоступен, так как для этого пользователя требуется наложение водяных знаков, а запрашиваемые media_links не поддерживают этот контент, запрос будет выполнен, но для неподдерживаемых ссылок на медиафайлы будет установлено значение null. Аналогично, если запрошенная ссылка на транскодирование не существует для определенного файла (например, включая “media_links.video_h264_180” на файл со статичным изображением) или процесс транскодирования не завершен (например, статус файла “добавлен”, а не “транскодирован”), тогда для ссылки будет установлено значение null в теле ответа. Одним словом, клиенту необходимо уметь работать со ссылками на медиафайлы со значением null.
Лимиты запросов: 10 вызовов за 1 сек. для account_user

Показать сведения о файле. <br/> Использовать параметр запроса "включить" для избирательного включения дополнительных свойств в ответ. <br/> Примечание. Если вы включаете "media_links.original", а у пользователя нет разрешения на загрузку файлов, тогда эта конечная точка ответит ошибкой "403 запрещено". Если контент недоступен, так как для этого пользователя требуется наложение водяных знаков, а запрашиваемые media_links не поддерживают этот контент, запрос будет выполнен, но для неподдерживаемых ссылок на медиафайлы будет установлено значение null. Аналогично, если запрошенная ссылка на транскодирование не существует для определенного файла (например, включая "media_links.video_h264_180" на файл со статичным изображением) или процесс транскодирования не завершен (например, статус файла "добавлен", а не "транскодирован"), тогда для ссылки будет установлено значение null в теле ответа. Одним словом, клиенту необходимо уметь работать со ссылками на медиафайлы со значением null. <br/>Лимиты запросов: 10 вызовов за 1 сек. для account_user

Аутентификация

AuthorizationBearer

Аутентификация Bearer в форме Bearer <token>, где token — ваш токен аутентификации.

Параметры пути

account_idstringОбязательный

Идентификатор сущности Frame.io или Adobe. Обычно это UUID Frame.io. Но для учетных записей, проектов, папок, файлов и стеков версий, которые хранятся в облачном хранилище Adobe (что характерно для учетных записей и проектов, подключенных к Workfront), в качестве идентификатора также может использоваться назначенный идентификатор Adobe. Эти идентификаторы должны иметь префикс adobe: (например, adobe:<adobe_org_id> для учетной записи, adobe:<adobe_asset_id> для проекта или папки, adobe:adobe:<adobe_asset_id>|<version> для файла).

file_idstringОбязательный

Параметры запроса

includeenumОпциональный

Поддерживаемые значения параметра запроса для включения конечных точек, которые возвращают файлы со ссылками на медиафайлы

Заголовки ответа

x-ratelimit-limitinteger

Лимит запросов

x-ratelimit-remaininginteger

Остаток лимита запросов

x-ratelimit-windowinteger

Окно лимита запросов (в мс)

Ответ

ОК

dataobject

Ошибки

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