> This page is for Plattform, version V4 (default). > For other versions, use one of these documentation indexes: > - V4 (default): https://next.developer.frame.io/platform/v4/llms.txt > - V4 Experimental: https://next.developer.frame.io/platform/v4-experimental/llms.txt > - Vorgängerversion: https://next.developer.frame.io/platform/v2/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://next.developer.frame.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://next.developer.frame.io/_mcp/server. # Postman-Sammlung In diesem Leitfaden geht es um die Grundlagen der offiziellen Frame.io Developer-API Postman-Sammlung, eine Sammlung vorgefertigter Anfragen, mit denen Sie in die Frame.io V4-API einsteigen können. Die Sammlung deckt das gesamte Spektrum der V4-API-Endpunkte ab, aufgeteilt in stabile und experimentelle Kategorien.Stabile Endpunkte sind produktionsreif, und experimentelle Endpunkte sind neuere Ergänzungen, die funktional sind, sich aber basierend auf Feedback ändern können, bevor sie als stabil eingestuft werden. ## Erste Schritte mit Postman > **Tip** > > In diesem Leitfaden wird davon ausgegangen, dass Sie Anmeldedaten für die API generiert haben.Falls nicht, beginnen Sie [hier](/platform/docs/quick-start). #### Postman-Konto erstellen und Setup wählen Erstellen Sie unter [postman.com](http://auth.postman.com/__redirect/login) Ihr Postman-Konto und wählen Sie Ihr Setup.Sie können die Postman-App [hier](https://www.postman.com/downloads/) herunterladen oder Postman im Web verwenden. #### Frame.io Developer API Postman-Sammlung importieren #### [Frame.io Developer API-Sammlung](https://www.postman.com/adobe/workspace/frame-io-v4-public-api/collection/33150877-924315f2-cc62-45f5-8153-77ff2aaa9067?action=share\&creator=33150877\&active-environment=33150877-cffd66a8-23bd-4c50-8891-29157ead1185) Hier abbiegen oder herunterladen ### Einrichten Ihrer Umgebung In der Frame.io Developer API-Sammlung gibt es eine standardmäßige Umgebung mit einer Reihe definierter Umgebungsvariablen. Die Werte `BASE_URL` und `IMS_BASE_URL` sind statisch.Entsprechend Ihren Kontoinformationen können zusätzliche Umgebungsvariablen konfiguriert werden. ![alt image](/_fern-img/0780e30f05ff2cee570d698b9adc209f24326281b60e23968e5d78e66c5c9b43.webp)![alt image](/_fern-img/663c863cbbec947567616faf433d79e3900e70ace3d8d9d26299ee20e204c064.webp) Unten finden Sie eine Tabelle mit einer Beschreibung der einzelnen Variablen, die in den Standard- und Staging-Umgebungen der Sammlung zu finden sind: | Variable | Beschreibung | So rufen Sie sie ab | Umgebung | | ------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ----------------- | | `BASE_URL` | Basis-URL für alle V4-API-Anfragen | Vorkonfiguriert, nicht bearbeiten | Standard | | `IMS_BASE_URL` | Basis-URL von Adobe IMS zur Authentifizierung | Vorkonfiguriert, nicht bearbeiten | Standard, Staging | | `IMS_CLIENT_ID` | Ihre Client-ID für die Frame.io-App | Seite mit Anmeldedaten in **[Adobe Developer Console](https://developer.adobe.com/developer-console/)** | Staging | | `IMS_CLIENT_SECRET` | Ihr Clientschlüssel für die Frame.io-App | Seite mit Anmeldedaten in **[Adobe Developer Console](https://developer.adobe.com/developer-console/)** | Staging | | `FOLDER_ID` | Eindeutige ID für den Zielordner | Im Rückmeldeobjekt des Ordners zurückgegeben | Standard | | `WEBHOOK_ID` | Eindeutige ID für einen konfigurierten Webhook | Im Rückmeldeobjekt des Webhooks zurückgegeben | Standard | | `ASSET_ID` | Eindeutige ID für ein Datei- oder Ordner-Asset | Im Rückmeldeobjekt der Datei oder des Ordners zurückgegeben | Standard | | `SHARE_ID` | Eindeutige ID für einen Freigabe-Link | Im Rückmeldeobjekt der Freigabe zurückgegeben | Standard | --- ### Einrichten der Autorisierung > **Tip** > > [ In dieser Anleitung wird OAuth 2.0 zur Authentifizierung mit der Frame.io V4-API verwendet. Informationen zu anderen Authentifizierungsmethoden wie Server-zu-Server (S2S) finden Sie im ](\Neuen Zugriffstoken abrufen\*\* den OAuth 2.0-Fluss. Dadurch wird ein Browserfenster geöffnet, um den Authentifizierungsprozess abzuschließen und den Token an Postman zurückzugeben. Wählen Sie zum Überprüfen Ihrer Autorisierungskonfiguration im Ordner „Benutzende“ die Anfrage **`GET Benutzendendetails`** aus und klicken Sie auf **Senden**. Mit der Antwort **`200 OK`** wird sowohl bestätigt, dass Ihre Sammlung korrekt konfiguriert ist, als auch, dass Sie sich bei dem richtigen Konto authentifiziert haben. Informationen zu Fehlern und Warnungen finden Sie im Leitfaden „Erste Schritte“ in \*\*\*\*]\(\ **Tip** > > Falls Sie mehrere Frame.io-Konten haben, werden diese in der Antwort als separate Objekte angezeigt. Sobald Sie Ihre Konto-ID erhalten haben, kopieren Sie den `id`-Wert aus der Antwort und speichern Sie ihn als Umgebungsvariable.Sie werden sie in künftigen Anfragen als `account_id` Pfad-Parameter mit `{{ACCOUNT_ID}}` referenzieren. --- ## Arbeitsbereiche und Projektvorgänge Ihre Frame.io-Dateien werden in Ordnern gespeichert, die innerhalb von Arbeitsbereichen in Projekten organisiert sind.Eine vollständige Übersicht der V4-Ressourcenhierarchie finden Sie \**]\(\ **Tip** > > Mit der nachfolgenden Anfrage **`PATCH Update user role in a Project`**, die sich im Ordner **Project Permissions** befindet, können Sie einem neu erstellten eingeschränkten Projekt Benutzende hinzufügen.(**[API-Referenz](/platform/docs/guides/postman-collection)**) --- ## Vorgänge in Ordnern und Dateien ### Auflisten untergeordneter Elemente in Ordnern Mit der Anfrage **`GET list folder children`** wird **[`/v4/accounts/:account_id/folders/:folder_id/children`](/platform/api-reference/folders/index)** aufgerufen, um die untergeordneten Elemente in einem gegebenen Ordner aufzulisten.Legen Sie in diesem Fall den Stammordner des Projekts als Umgebungsvariable **`FOLDER_ID`** fest. Mit den folgenden optionalen Abfrageparametern können Sie Ihre Rückmeldung verfeinern: | Parameter | Typ | Beschreibung | | ------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **`page_size`** | Ganzzahl | Begrenzt die Anzahl der zurückgegebenen Ordner auf **1-100.Standardwert ist 50** | | **`type`** | Zeichenfolge | Filtert untergeordnete Elemente von Ordnern anhand des Ressourcentyps: **`file`** oder **`folder`**. | | **`after`** | Zeichenfolge | Intransparenter Cursor für Anfragen, bei denen paginierte Ergebnisse zurückgegeben werden. \*\*Dieser wird automatisch generiert und im Objekt `links` der vorherigen Antwort zurückgegeben.\*\*Er ist nicht dafür vorgesehen, für Menschen lesbar zu sein. | | **`include_total_count`** | Boolescher Wert | Gibt die Gesamtanzahl aller Entitäten zurück **Standardwert ist „False“.** | | **`include`** | Enum | Hängt an jedes zurückgegebene Objekt zusätzliche Daten an, etwa `creator`, `project`, `media_links`. Eine vollständige Liste der unterstützten Parameter finden Sie in der **[API-Referenz](/platform/api-reference/folders/index#request.query.include)**. | Bei einer erfolgreichen Anfrage wird der Status \*\*`200 OK`\*\*und ein Antwortfließtext zurückgegeben, ähnlich dem unten stehenden Beispiel.**Beispielantwort** ``` { "data": [ { "type": "file", "created_at": "2023-09-25T19:18:29.614189Z", "file_size": 1137444, "id": "cba3b1c5-c644-4592-91c5-0d0b91f4895d", "media_type": "image/png", "name": "asset.png", "parent_id": "2559e2c4-9bb9-4284-b616-a97700a579a4", "project_id": "955c0511-656a-4859-b824-ebdbfdcb615b", "status": "created", "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", "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": "b859ccec-9536-4bf2-bc6f-5e9206e26606", "field_definition_name": "Fields definition name", "mutable": true, "value": [ { "display_name": "Display name", "id": "212add59-6527-4fd2-ac30-55ea94a8b5f8" } ], "field_options": [ { "display_name": "Display name", "id": "212add59-6527-4fd2-ac30-55ea94a8b5f8" }, { "display_name": "Display name 2", "id": "c6eb873f-125b-4317-b857-1a22eb3dbf22" } ] } ], "project": { "created_at": "2024-01-25T19:18:29.614189Z", "description": "Project Description", "id": "e0e30b1d-c3aa-44ee-926e-c6c326fb10dc", "name": "My Project", "root_folder_id": "be733511-6f15-4d97-8ee7-bc23b2fb0bd7", "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": "91b10e83-5874-44de-9b57-41c937b87256", "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" }, "restricted": false } } ], "links": { "next": "/v4/accounts/123/folders/123/folders" }, "total_count": 10 } ``` > **Testen des Parameters \\after\\** > > Wenn Sie paginierte Ergebnisse testen, suchen Sie in Ihrer Antwort nach dem Objekt **`links`**: > > * Kopieren Sie aus der Eigenschafts-URL **`next`** nur den Zeichenfolgenwert, der auf **`after=`** folgt. > > * Legen Sie diesen in Ihrer nächsten Anfrage als Wert des Abfrageparameters\*\*`after`\*\* fest. > > * **Achten Sie auf doppelte Codierung!**Wenn die URL codierte Zeichen enthält (z. B.: %3D%3D), ersetzen Sie sie durch die Rohversion (**==**).Ihre Eingabe wird wörtlich von Postman interpretiert, wodurch die Zeichen möglicherweise doppelt codiert werden, was wiederum zu dem Fehler **`422`** führt. --- ### Dateien erstellen – Lokaler Upload Mit der Anfrage **`POST create file - local upload`** wird **[`/v4/accounts/:account_id/folders/:folder_id/files/local_upload`](/platform/v4/api-reference/files/create-local-upload)** aufgerufen, um eine lokale Datei in einem bestimmten Ordner hochzuladen. Lokale Uploads erfordern zwei oder mehr Anfragen, je nach Dateigröße.Verwenden Sie für Ihren ersten Test eine kleine Datei (weniger als 10 MB), um den Prozess auf eine einzige Upload-URL zu begrenzen. #### Platzhalter-Dateiressource erstellen Wählen Sie im Anfrageneditor die Registerkarte **Fließtext** aus, um den Namen und die Dateigröße (angegeben in **Bytes**) im `data`-Objekt festzulegen.Bei einer erfolgreichen Anfrage wird der Status **`201 Created`** und ein Antwortfließtext zurückgegeben, ähnlich dem unten stehenden Beispiel.**Beispielantwort** ``` { "data": { "created_at": "2023-09-25T19:18:29.614189Z", "file_size": 1137444, "media_type": "image/png", "parent_id": "2559e2c4-9bb9-4284-b616-a97700a579a4", "project_id": "955c0511-656a-4859-b824-ebdbfdcb615b", "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", "id": "cba3b1c5-c644-4592-91c5-0d0b91f4895d", "name": "asset.png", "upload_urls": [ { "size": 20000000, "url": "https://my.fileupload.url.dev" } ] } } ``` Durch diesen Aufruf wird im angegebenen Ordner eine Platzhalter-Dateiressource erstellt.Verwenden Sie in der Antwort die vorsignierte Upload-URL im `upload_urls`-Array, um den Upload im nächsten Schritt abzuschließen. #### Dateiinhalt hochladen Klicken Sie in Ihrer Antwort auf die URL im `upload_urls`-Array, um in Postman eine neue Registerkarte „Anfrage“ zu öffnen.Ändern Sie die Anfragemethode in **`PUT`**.Wählen Sie im Anfrageneditor die Registerkarte **Headers** aus, um der Anfrage die folgenden Header hinzuzufügen: * **`x-amz-acl`:`private`*** **`Content-Type`**: Dieser muss exakt mit dem im Dateinamen angegebenen Erweiterungstyp übereinstimmen (für eine Datei namens **`IMG.png`** zum Beispiel muss **`image/png`** verwendet werden). ![alt image](/_fern-img/86ddb4aebecaffdee01cf07be3c2e7af0b616285721ec8ef412575114a916b21.webp) Wählen Sie im Anfrageneditor die Registerkarte **Fließtext** aus und klicken Sie auf die Option **binär**, um Ihre Datei auszuwählen.Klicken Sie nach der Auswahl auf **Senden**, um Ihre Anfrage abzuschließen.Bei einer erfolgreichen Anfrage wird der Status \*\*`200 OK`\*\*zurückgegeben und bestätigt, dass Ihre Datei hochgeladen wurde. Sobald Ihre Datei hochgeladen wurde, wird sie in der Frame.io-Medien-Pipeline automatisch transkodiert und eine Miniaturansicht wird erstellt.Bei größeren Dateien kann es einen Moment dauern, bis die Datei vom Status **`created`** in den Status **`ready`** wechselt. --- ### Datei erstellen – Remote-Upload Mit der Anfrage **`POST create file - remote upload`** wird **[`/v4/accounts/:account_id/folders/:folder_id/files/remote_upload`](/platform/v4/api-reference/files/create-remote-upload)** aufgerufen, um eine externe Datei mittels einer bereitgestellten Quell-URL in einen angegebenen Ordner zu ziehen. Wählen Sie im Anfrageneditor die Registerkarte **Fließtext** aus, um den Namen und die Quell-URL Ihrer Datei im `data`-Objekt festzulegen.Bei einer erfolgreichen Anfrage wird der Status **`202 Accepted`** und ein Antwortfließtext zurückgegeben, ähnlich dem unten stehenden Beispiel.**Beispielantwort** ``` { "data": { "created_at": "2023-09-25T19:18:29.614189Z", "file_size": 1137444, "media_type": "image/png", "parent_id": "2559e2c4-9bb9-4284-b616-a97700a579a4", "project_id": "955c0511-656a-4859-b824-ebdbfdcb615b", "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", "id": "cba3b1c5-c644-4592-91c5-0d0b91f4895d", "name": "asset.png" }, "links": { "status": "/v4/accounts/fb4dd62f-8a89-4e98-8fa1-ad4b29a0094f/files/eab70952-966c-4d99-949b-f0a947ca5754/status" } } ```