파일 표시 | Frame.io API Documentation

from frameio_experimental import FrameioExperimental
client = FrameioExperimental(
    token="YOUR_TOKEN_HERE",
)
client.files.show(
    account_id="9d6b1b99-39a3-4710-8985-25143af75a1d",
    file_id="5bbf8ce0-09f9-49bc-bc92-693a193d13c5",
    include="media_links.original",
)

{
  "data": {
    "file_size": 1137444,
    "id": "063a0dbd-f98e-478a-b75b-ecef21736b1c",
    "media_type": "image/png",
    "name": "asset.png",
    "status": "created",
    "created_at": "2023-09-25T19:18:29.614189Z",
    "parent_id": "9142af45-e874-4fba-bc3a-029d45eebf93",
    "project_id": "66d950ae-ab23-4e85-8d00-1afac092c47e",
    "type": "file",
    "updated_at": "2024-02-07T16:44:41.986478Z",
    "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c",
    "adobe_version_id": "2",
    "media_links": {
      "high_quality": {
        "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"
      },
      "original": {
        "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",
        "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"
      },
      "thumbnail": {
        "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",
        "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"
      }
    },
    "adobe_id": "urn:aaid:sc:US:a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "creator": {
      "active": true,
      "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",
      "email": "user_email@example.com",
      "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
      "name": "Jon Doe"
    },
    "metadata": [
      {
        "field_type": "select",
        "field_definition_id": "8fb17fb6-f32f-45e2-bfe3-c81bb75ddcee",
        "field_definition_name": "Fields definition name",
        "mutable": true,
        "value": [
          {
            "display_name": "Display name",
            "id": "03f89c79-f5ca-48e8-b4f7-208520126847"
          }
        ],
        "field_options": [
          {
            "display_name": "Display name",
            "id": "03f89c79-f5ca-48e8-b4f7-208520126847"
          },
          {
            "display_name": "Display name 2",
            "id": "7f9a8b14-4b45-4d62-87b6-f74bafeaa97e"
          }
        ]
      }
    ],
    "project": {
      "created_at": "2024-01-25T19:18:29.614189Z",
      "id": "94638bd5-5d6f-49f0-8e57-e597e0bca7d2",
      "name": "My Project",
      "root_folder_id": "7ab5d6b7-2cb5-45ac-9656-16c4beb37760",
      "status": "active",
      "storage": 15000,
      "updated_at": "2024-02-07T16:44:41.986478Z",
      "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/",
      "workspace_id": "e4e1c2f7-4a9a-4fec-b126-0bc6d8c51a80",
      "description": "Project Description",
      "adobe_id": "urn:aaid:sc:US:9f4e4d7a-4b6b-4c4f-9f00-b31a91cfc6f3",
      "restricted": false,
      "owner": {
        "active": true,
        "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",
        "email": "user_email@example.com",
        "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
        "name": "Jon Doe"
      }
    }
  }
}

Show file details.
Use the include query parameter to selectively include additional properties in the response.
Note: if you include media_links.original and the user does not have permission to download the file then this endpoint will respond with a 403 Forbidden error. If the content is inaccessible because watermarking is required for this user and isn’t supported by the requested media_links, then the request will succeed but the unsupported media links will be set to null. Similarly, if a requested transcode link does not exist for a particular file (e.g. including media_links.video_h264_180 on a static image file) or transoding process hasn’t completed (i.e. the file’s status is “uploaded” rather than “transcoded”), then the link will also be set to null in the response payload. In short, the client must handle null media links gracefully.
Rate Limits: 5 calls per 1 second(s) per account_user

Show file details. <br/>Use the `include` query parameter to selectively include additional properties in the response. <br/>Note: if you include `media_links.original` and the user does not have permission to download the file then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because watermarking is required for this user and isn't supported by the requested media_links, then the request will succeed but the unsupported media links will be set to null. Similarly, if a requested transcode link does not exist for a particular file (e.g. including `media_links.video_h264_180` on a static image file) or transoding process hasn't completed (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in the response payload. In short, the client must handle null media links gracefully. <br/>Rate Limits: 5 calls per 1 second(s) per account_user

인증

AuthorizationBearer

Bearer <token> 형식의 Bearer 인증. 여기서 token은 인증 토큰입니다.

경로 매개변수

account_idstring필수

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).

file_idstring필수

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).

쿼리 매개변수

includeenum선택 사항

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

응답 헤더

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

응답

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