Show file | Frame.io API Documentation

from frameio_experimental import FrameioExperimental
client = FrameioExperimental()
client.files.show(
    account_id="2c631ea7-58c2-45d2-9712-0f6537e10c0e",
    file_id="d8e366e0-f1ed-4001-b2e2-f09ad4cad570",
    include="media_links",
    api_version="experimental",
)

{
  "data": {
    "file_size": 1137444,
    "id": "67b11ddd-fadc-45f0-ac1d-2f8ae929126c",
    "media_type": "image/png",
    "name": "asset.png",
    "status": "created",
    "created_at": "2023-09-25T19:18:29.614189Z",
    "parent_id": "06dd2657-2d56-4c80-afcc-482284725745",
    "project_id": "abdc8443-a4a1-4179-b052-00fe593c841e",
    "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",
    "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"
      }
    },
    "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": "bfcf8f07-2f7d-413e-99ac-9c4eec9266fa",
        "field_definition_name": "Fields definition name",
        "mutable": true,
        "value": [
          {
            "display_name": "Display name",
            "id": "6ec91e7f-6411-4bd5-98fe-202662275123"
          }
        ],
        "field_options": [
          {
            "display_name": "Display name",
            "id": "6ec91e7f-6411-4bd5-98fe-202662275123"
          },
          {
            "display_name": "Display name 2",
            "id": "1a2dd824-ce0b-4392-9920-c00108675449"
          }
        ]
      }
    ],
    "project": {
      "created_at": "2024-01-25T19:18:29.614189Z",
      "description": "Project Description",
      "id": "3d17f8db-71d7-412b-b3f6-3660dca64b4e",
      "name": "My Project",
      "root_folder_id": "5accdd89-c31f-4fdb-8abe-0d2aa9e3af11",
      "storage": 15000,
      "updated_at": "2024-02-07T16:44:41.986478Z",
      "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/",
      "workspace_id": "d6afb262-b63c-4f5d-a8f0-36fb90837655",
      "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.

This endpoint has been added to Current Version of the API.

Please see https://developer.adobe.com/frameio/api/current/#tag/Files/operation/files.show.

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. This endpoint has been added to `Current Version` of the API. Please see https://developer.adobe.com/frameio/api/current/#tag/Files/operation/files.show. 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

Path parameters

account_idstringRequiredformat: "uuid"

A UUID String

file_idstringRequiredformat: "uuid"

A UUID String

Query parameters

includeenumOptional

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

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

Path parameters

Headers

Query parameters

Response

Errors