Afficher le fichier | Frame.io API Documentation

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

{
  "data": {
    "created_at": "2023-09-25T19:18:29.614189Z",
    "file_size": 1137444,
    "id": "b4c00e24-9beb-4c38-91ad-8f58a88f5a8a",
    "media_type": "image/png",
    "name": "asset.png",
    "parent_id": "6ecaf9c3-23ab-4031-8dc8-8acbfec1afbd",
    "project_id": "70e467b0-c8ab-4881-9c63-836664103a26",
    "status": "created",
    "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_id": "urn:aaid:sc:US:a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "adobe_version_id": "2",
    "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"
    },
    "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"
      }
    },
    "metadata": [
      {
        "field_type": "select",
        "field_definition_id": "36279dd3-a607-432e-ad85-2005522b3c4e",
        "field_definition_name": "Fields definition name",
        "mutable": true,
        "value": [
          {
            "display_name": "Display name",
            "id": "6711d43d-b717-4765-bde4-994bf39f88df"
          }
        ],
        "field_options": [
          {
            "display_name": "Display name",
            "id": "6711d43d-b717-4765-bde4-994bf39f88df"
          },
          {
            "display_name": "Display name 2",
            "id": "6f10a133-919f-43f0-8e67-13efc50ba439"
          }
        ]
      }
    ],
    "project": {
      "created_at": "2024-01-25T19:18:29.614189Z",
      "id": "90d3f72c-abed-463f-8d1b-1c3c084556e1",
      "name": "My Project",
      "root_folder_id": "a8426cb1-5056-4010-92d0-416e2c0d3a78",
      "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": "f9cc69f8-c0f8-4176-9eb1-3049c4b6b647",
      "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"
      }
    }
  }
}

Afficher les détails d’un fichier.

Le paramètre de requête include permet d’inclure de manière sélective des propriétés supplémentaires dans la réponse.

Remarque : si vous incluez media_links.original et que l’utilisateur ne dispose pas de l’autorisation de télécharger le fichier, ce point d’entrée renvoie une erreur 403 Forbidden. Si le contenu est inaccessible parce que l’ajout d’un filigrane est requis pour cet utilisateur et n’est pas pris en charge par les media_links demandés, la requête aboutit, mais les liens média non pris en charge sont définis sur NULL. De même, si un lien de transcodage demandé n’existe pas pour un fichier particulier (par exemple, en incluant media_links.video_h264_180 sur un fichier image statique) ou si le processus de transcodage n’est pas terminé (c’est-à-dire que le statut (status) du fichier est “uploaded” plutôt que “transcoded”), le lien est également défini sur NULL dans la payload de la réponse. En bref, le client doit gérer les liens média NULL correctement.
Limites de débit : 10 appels par seconde et par account_user

Afficher les détails d’un fichier. <br/> Le paramètre de requête `include` permet d’inclure de manière sélective des propriétés supplémentaires dans la réponse. <br/> Remarque : si vous incluez `media_links.original` et que l’utilisateur ne dispose pas de l’autorisation de télécharger le fichier, ce point d’entrée renvoie une erreur `403 Forbidden`. Si le contenu est inaccessible parce que l’ajout d’un filigrane est requis pour cet utilisateur et n’est pas pris en charge par les media_links demandés, la requête aboutit, mais les liens média non pris en charge sont définis sur NULL. De même, si un lien de transcodage demandé n’existe pas pour un fichier particulier (par exemple, en incluant `media_links.video_h264_180` sur un fichier image statique) ou si le processus de transcodage n’est pas terminé (c’est-à-dire que le statut (`status`) du fichier est "uploaded" plutôt que "transcoded"), le lien est également défini sur NULL dans la payload de la réponse. En bref, le client doit gérer les liens média NULL correctement. <br/>Limites de débit : 10 appels par seconde et par account_user

Authentification

AuthorizationBearer

Authentification bearer de la forme Bearer <token>, où token est votre jeton d’authentification.

Paramètres de chemin

account_idstringRequis

Identifiant d’entité Adobe ou Frame.io. Il s’agit généralement d’un UUID Frame.io. Toutefois, pour les comptes, les projets, les dossiers, les fichiers et les piles de versions qui résident dans l’espace de stockage Adobe, ce qui est le cas des comptes et projets reliés à Workfront, un ID attribué par Adobe peut également être utilisé de manière interchangeable. Ces ID doivent être préfixés de la mention adobe: (par exemple, adobe:<adobe_org_id> pour un compte, adobe:<adobe_asset_id> pour un projet ou un dossier, et adobe:<adobe_asset_id>|<version> pour un asset de fichier).

Identifiant d’entité Adobe ou Frame.io. Il s’agit généralement d’un UUID Frame.io. Toutefois, pour les comptes, les projets, les dossiers, les fichiers et les piles de versions qui résident dans l’espace de stockage Adobe, ce qui est le cas des comptes et projets reliés à Workfront, un ID attribué par Adobe peut également être utilisé de manière interchangeable. Ces ID doivent être préfixés de la mention `adobe:` (par exemple, `adobe:<adobe_org_id>` pour un compte, `adobe:<adobe_asset_id>` pour un projet ou un dossier, et `adobe:<adobe_asset_id>|<version>` pour un asset de fichier).

file_idstringRequis

Identifiant d’entité Adobe ou Frame.io. Il s’agit généralement d’un UUID Frame.io. Toutefois, pour les comptes, les projets, les dossiers, les fichiers et les piles de versions qui résident dans l’espace de stockage Adobe, ce qui est le cas des comptes et projets reliés à Workfront, un ID attribué par Adobe peut également être utilisé de manière interchangeable. Ces ID doivent être préfixés de la mention `adobe:` (par exemple, `adobe:<adobe_org_id>` pour un compte, `adobe:<adobe_asset_id>` pour un projet ou un dossier, et `adobe:<adobe_asset_id>|<version>` pour un asset de fichier).

Paramètres de requête

includeenumOptionnel

Valeurs prises en charge du paramètre de requête include pour les points d’entrée qui renvoient des fichiers comportant des liens de médias

En-têtes de réponse

x-ratelimit-limitinteger

Limite de débit

x-ratelimit-remaininginteger

Limite de débit restante

x-ratelimit-windowinteger

Fenêtre de limite de débit en millisecondes

Réponse

dataobject

Erreurs

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

Afficher les détails d’un fichier.

Le paramètre de requête include permet d’inclure de manière sélective des propriétés supplémentaires dans la réponse.