> 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. # TypeScript SDK-Referenz --- ### Installation ```curl npm i -s frameio ``` --- ### Verwendung Instanziieren Sie den Client und verwenden Sie ihn mit dem Folgenden: ```ts import { FrameioClient } from "frameio"; const client = new FrameioClient({ token: "YOUR_TOKEN" }); await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { field_type: "select", field_configuration: { enable_add_new: false, options: [ { display_name: "Option 1", }, { display_name: "Option 2", }, ], }, name: "Fields definition name", }, }); ``` --- ### Anfrage- und Antworttypen Alle Anfrage- und Antworttypen werden vom SDK als TypeScript-Schnittstellen exportiert.Importieren Sie sie einfach mit dem folgenden Namespace: ```ts import { Frameio } from "frameio"; const request: Frameio.UpdateFieldDefinitionParams = { ... }; ``` --- ### Ausnahmebehandlung Wenn die API einen Nichterfolgs-Statuscode zurückgibt (4xx- oder 5xx-Antwort), wird eine Unterklasse des folgenden Fehlers ausgelöst. ```ts import { FrameioError } from "frameio"; try { await client.metadataFields.metadataFieldDefinitionsCreate(...); } catch (err) { if (err instanceof FrameioError) { console.log(err.statusCode); console.log(err.message); console.log(err.body); console.log(err.rawResponse); } } ``` --- ### Erweitert #### Zusätzliche Header Wenn Sie zusätzliche Header als Teil der Anfrage senden möchten, verwenden Sie die Option für Header-Anfragen. ```ts const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., { headers: { 'X-Custom-Header': 'custom value' } }); ``` #### Zusätzliche Parameter für Abfragezeichenfolgen Falls Sie zusätzliche Abfragezeichenfolgen-Parameter als Teil der Anfrage senden möchten, verwenden Sie die Anfrageoption queryParams. ```ts const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., { queryParams: { 'customQueryParamKey': 'custom query param value' } }); ``` --- #### Wiederholungsversuche Das SDK ist mit automatischen Wiederholungsversuchen mit exponentiellem Rückzug ausgestattet.Eine Anfrage wird wiederholt, solange sie als wiederholbar eingestuft wird und die Anzahl der Wiederholungsversuche nicht größer geworden ist als der konfigurierte Wiederholungsgrenzwert (Standard: 2). Eine Anfrage wird als wiederholbar eingestuft, wenn einer der folgenden HTTP-Statuscodes zurückgegeben wird: * 408 (Timeout) * 429 (Too Many Requests) * 5XX (Internal Server Errors) \ Dieses Verhalten konfigurieren Sie mit der Anfrageoption `maxRetries`. ```ts const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., { maxRetries: 0 // override maxRetries at the request level }); ``` --- #### Timeouts Im SDK ist standardmäßig ein Timeout (Zeitüberschreitung) von 60 Sekunden eingestellt.Konfigurieren Sie dieses Verhalten mit der Option timeoutInSeconds. ```ts const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., { timeoutInSeconds: 30 // override timeout to 30s }); ``` #### Abbrechen von Anfragen Im SDK können Benutzende Anfragen jederzeit abbrechen, indem sie ein Abbruchsignal übergeben. ```ts const controller = new AbortController(); const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., { abortSignal: controller.signal }); controller.abort(); // aborts the request ``` --- #### Zugreifen auf Rohdaten der Antwort Mit dem SDK ist durch die Methode `.withRawResponse()` der Zugriff auf Rohdaten der Antwort möglich, einschließlich Header.Von der Methode `.withRawResponse()` wird ein Versprechen zurückgegeben, das zu einem Objekt mit den Eigenschaften `data` und `rawResponse` führt. ```ts const { data, rawResponse } = await client.metadataFields.metadataFieldDefinitionsCreate(...).withRawResponse(); console.log(data); console.log(rawResponse.headers['X-My-Header']); ``` #### Laufzeitkompatibilität Das SDK funktioniert in den folgenden Laufzeiten: * Node.js 18+ * Vercel * Cloudflare Workers * Deno v1.25+ * Bun 1.0+ * React Native --- #### Anpassen des Abruf-Clients Im SDK können Sie den zugrunde liegenden HTTP-Client / die Abruffunktion anpassen.Wenn Sie in einer nicht unterstützten Umgebung arbeiten, haben Sie dadurch die Möglichkeit, im Notfall einzugreifen und zu gewährleisten, dass das SDK funktioniert. ```ts import { FrameioClient } from "frameio"; const client = new FrameioClient({ ... fetcher: // provide your implementation here }); ``` --- ### Referenz #### Kontoberechtigungen #### client.accountPermissions.index(accountId, \{ ...params }) -> core.Page\ Listet Benutzendenrollen für ein gegebenes Konto auf. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage const response = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include_deactivated: true, after: "", page_size: 10, include_total_count: false, }); for await (const item of response) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include_deactivated: true, after: "", page_size: 10, include_total_count: false, }); while (page.hasNextPage()) { page = page.getNextPage(); } ``` **Parameter** `accountId`: `Frameio.Uuid` – `request`: `Frameio.AccountPermissionsIndexRequest` `requestOptions`: `AccountPermissions.RequestOptions` #### Konten #### client.accounts.index(\{ ...params }) -> core.Page\ Listet Konten für den aktuellen Benutzer bzw. die aktuelle Benutzerin auf. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage const response = await client.accounts.index({ after: "", page_size: 10, include_total_count: false, }); for await (const item of response) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.accounts.index({ after: "", page_size: 10, include_total_count: false, }); while (page.hasNextPage()) { page = page.getNextPage(); } ``` **Parameter** `request`: `Frameio.AccountsIndexRequest` `requestOptions`: `Accounts.RequestOptions` #### client.accounts.auditlogIndex(accountId, \{ ...params }) -> Frameio.AuditLogsWithIncludesResponse Auditprotokolle mit Filterungsmöglichkeiten über Abfrageparameter auflisten Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "user", after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `request`: `Frameio.AuditlogIndexRequest` `requestOptions`: `Accounts.RequestOptions` #### Auth #### new ServerToServerAuth(\{ clientId, clientSecret, ... }) Authentifizierung mit dem OAuth 2.0 `client_credentials`-Grant. In diesem Fluss gibt es keine Benutzenden, und es wird kein Aktualisierungstoken zurückgegeben.Wenn der Zugriffstoken abläuft, wird vom SDK mithilfe der Client-Anmeldedaten automatisch ein neuer angefordert. **`usage`** ```ts usage import { FrameioClient, ServerToServerAuth } from "frameio"; const auth = new ServerToServerAuth({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET", }); const client = new FrameioClient({ token: () => auth.getToken() }); ``` **Parameter** `clientId`: `string` – Adobe IMS OAuth Client-ID. `clientSecret`: `string` – Adobe IMS OAuth Clientschlüssel. `scopes`: `string` – Durch Leerzeichen getrennte Gültigkeitsbereiche (OAuth 2.0 RFC 6749). Standardmäßig werden die Server-zu-Server-Gültigkeitsbereiche verwendet. `imsBaseUrl`: `string` – IMS-Basis-URL für Staging / alternative Umgebungen. Standardwert ist „Produktion“. `fetch`: `typeof fetch` – Selbstdefinierte Implementierung von fetch (für Proxy, TLS usw.). `onTokenRefreshed`: `OnTokenRefreshed` – Optionaler Rückruf, der nach jedem Tokenabruf ausgelöst wird. `timeout`: `number` – Timeout der HTTP-Anfrage in Millisekunden. Standardwert ist 30000. `maxRetries`: `number` – Maximale Anzahl von Wiederholungsversuchen bei vorübergehenden Fehlern. Standardwert ist 2. `refreshBuffer`: `number` – Sekunden vor Ablauf, um proaktive Aktualisierung auszulösen. Standardwert ist 60. `logger`: `Logger` – Instanz der Protokolleinrichtung für Diagnoseausgaben. **Methoden**`getToken(): Promise` – Gibt einen gültigen Zugriffstoken zurück, der bei Bedarf aktualisiert wird. Übergeben an den Client: `new FrameioClient({ token: () => auth.getToken() })`. `authenticate(): Promise` – Fordert explizit einen neuen Zugriffstoken an. `revoke(): Promise` – Widerruft beide Token serverseitig und löscht den lokalen Status. `exportTokens(): ExportedTokens` – Exportiert den aktuellen Status des Tokens zur dauerhaften Speicherung. `importTokens(data: ExportedTokens): void` – Stellt den Token-Status aus einem zuvor exportierten Objekt wieder her. #### new WebAppAuth(\{ clientId, clientSecret, redirectUri, ... }) Authentifizierung mit dem OAuth 2.0 `authorization_code`-Grant. Geeignet für serverseitige Anwendungen, in denen ein Clientschlüssel sicher gespeichert werden kann. **`usage`** ```ts usage import { randomBytes } from "crypto"; import { FrameioClient, WebAppAuth } from "frameio"; const auth = new WebAppAuth({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET", redirectUri: "https://myapp.com/callback", }); const url = auth.getAuthorizationUrl({ state: randomBytes(24).toString("hex") }); // redirect the user to url ... await auth.exchangeCode("CODE_FROM_CALLBACK"); const client = new FrameioClient({ token: () => auth.getToken() }); ``` **Parameter** `clientId`: `string` – Adobe IMS OAuth Client-ID. `clientSecret`: `string` – Adobe IMS OAuth Clientschlüssel. `redirectUri`: `string` – Registrierter Umleitungs-URI. `scopes`: `string` – Durch Leerzeichen getrennte Gültigkeitsbereiche (OAuth 2.0 RFC 6749). `imsBaseUrl`: `string` – IMS-Basis-URL für Staging / alternative Umgebungen.Standardwert ist „Produktion“. `fetch`: `typeof fetch` – Selbstdefinierte Implementierung von fetch (für Proxy, TLS usw.). `onTokenRefreshed`: `OnTokenRefreshed` – Optionaler Rückruf, der nach jeder Tokenaktualisierung ausgelöst wird. `timeout`: `number` – Timeout der HTTP-Anfrage in Millisekunden.Standardwert ist 30000. `maxRetries`: `number` – Maximale Anzahl von Wiederholungsversuchen bei vorübergehenden Fehlern.Standardwert ist 2. `refreshBuffer`: `number` – Sekunden vor Ablauf, um proaktive Aktualisierung auszulösen.Standardwert ist 60. `logger`: `Logger` – Instanz der Protokolleinrichtung für Diagnoseausgaben.**Methoden**`getToken(): Promise` – Gibt einen gültigen Zugriffstoken zurück, der bei Bedarf aktualisiert wird.`getAuthorizationUrl({ state }): string` – Adobe IMS Autorisierungs-URL erstellen. Übergibt einen intransparenten CSRF-/Zustandswert, der als Echo ausgegeben wird.`exchangeCode(code: string): Promise` – Eintauschen eines Autorisierungscodes gegen Zugriffs- und Aktualisierungstoken. `refresh(): Promise` – Manuelles Auslösen der Tokenaktualisierung. `revoke(): Promise` – Widerruft beide Token serverseitig und löscht den lokalen Status.`exportTokens(): ExportedTokens` – Exportiert den aktuellen Status des Tokens zur dauerhaften Speicherung.`importTokens(data: ExportedTokens): void` – Stellt den Token-Status aus einem zuvor exportierten Objekt wieder her. #### new SPAAuth(\{ clientId, redirectUri, ... }) Authentifiziert mit `authorization_code` und PKCE (ohne Clientschlüssel). Dies ist für browserbasierte Anwendungen mit einer einzelnen Seite vorgesehen, in denen ein Clientschlüssel nicht sicher gespeichert werden kann. **`usage`** ```ts usage import { randomBytes } from "crypto"; import { FrameioClient, SPAAuth } from "frameio"; const auth = new SPAAuth({ clientId: "YOUR_CLIENT_ID", redirectUri: "https://myapp.com/cb", }); const result = await auth.getAuthorizationUrl({ state: randomBytes(24).toString("hex") }); // redirect the user to result.url, store result.codeVerifier ... await auth.exchangeCode({ code: "CODE_FROM_CALLBACK", codeVerifier: result.codeVerifier }); const client = new FrameioClient({ token: () => auth.getToken() }); ``` **Parameter** `clientId`: `string` – Adobe IMS OAuth Client-ID. `redirectUri`: `string` – Registrierter Umleitungs-URI. `scopes`: `string` – Durch Leerzeichen getrennte Gültigkeitsbereiche (OAuth 2.0 RFC 6749). `imsBaseUrl`: `string` – IMS-Basis-URL für Staging / alternative Umgebungen.Standardwert ist „Produktion“. `fetch`: `typeof fetch` – Selbstdefinierte Implementierung von fetch (für Proxy, TLS usw.). `onTokenRefreshed`: `OnTokenRefreshed` – Optionaler Rückruf, der nach jeder Tokenaktualisierung ausgelöst wird. `timeout`: `number` – Timeout der HTTP-Anfrage in Millisekunden.Standardwert ist 30000. `maxRetries`: `number` – Maximale Anzahl von Wiederholungsversuchen bei vorübergehenden Fehlern.Standardwert ist 2. `refreshBuffer`: `number` – Sekunden vor Ablauf, um proaktive Aktualisierung auszulösen.Standardwert ist 60. `logger`: `Logger` – Instanz der Protokolleinrichtung für Diagnoseausgaben.**Methoden**`getToken(): Promise` – Gibt einen gültigen Zugriffstoken zurück, der bei Bedarf aktualisiert wird.`getAuthorizationUrl({ state }): Promise` – Erstellt die Adobe IMS-Autorisierungs-URL mit einer PKCE-Challenge. Gibt ein `AuthorizationUrlResult` mit den Attributen `url` und `codeVerifier` zurück. `exchangeCode({ code, codeVerifier }): Promise` – Eintauschen eines Autorisierungscodes und PKCE-Prüfers gegen Token. `refresh(): Promise` – Manuelles Auslösen der Tokenaktualisierung.`revoke(): Promise` – Widerruft beide Token serverseitig und löscht den lokalen Status.`exportTokens(): ExportedTokens` – Exportiert den aktuellen Status des Tokens zur dauerhaften Speicherung.`importTokens(data: ExportedTokens): void` – Stellt den Token-Status aus einem zuvor exportierten Objekt wieder her. #### new NativeAppAuth(\{ clientId, redirectUri, ... }) Authentifizieren mit `authorization_code` und PKCE bei Desktop- und mobilen Anwendungen. Dabei wird die gleiche API wie bei `SPAAuth` genutzt; verwenden Sie einen selbstdefinierten Schema-Umleitungs-URI (z. B. `myapp://callback`). **`usage`** ```ts usage import { randomBytes } from "crypto"; import { FrameioClient, NativeAppAuth } from "frameio"; const auth = new NativeAppAuth({ clientId: "YOUR_CLIENT_ID", redirectUri: "myapp://callback", }); const result = await auth.getAuthorizationUrl({ state: randomBytes(24).toString("hex") }); // open result.url in the system browser, store result.codeVerifier ... await auth.exchangeCode({ code: "CODE_FROM_CALLBACK", codeVerifier: result.codeVerifier }); const client = new FrameioClient({ token: () => auth.getToken() }); ``` **Parameter** `clientId`: `string` – Adobe IMS OAuth Client-ID. `redirectUri`: `string` – Registrierter Umleitungs-URI (selbstdefinierte Schemata werden unterstützt). `scopes`: `string` – Durch Leerzeichen getrennte Gültigkeitsbereiche (OAuth 2.0 RFC 6749). `imsBaseUrl`: `string` – IMS-Basis-URL für Staging / alternative Umgebungen.Standardwert ist „Produktion“. `fetch`: `typeof fetch` – Selbstdefinierte Implementierung von fetch (für Proxy, TLS usw.). `onTokenRefreshed`: `OnTokenRefreshed` – Optionaler Rückruf, der nach jeder Tokenaktualisierung ausgelöst wird. `timeout`: `number` – Timeout der HTTP-Anfrage in Millisekunden.Standardwert ist 30000. `maxRetries`: `number` – Maximale Anzahl von Wiederholungsversuchen bei vorübergehenden Fehlern.Standardwert ist 2. `refreshBuffer`: `number` – Sekunden vor Ablauf, um proaktive Aktualisierung auszulösen.Standardwert ist 60. `logger`: `Logger` – Instanz der Protokolleinrichtung für Diagnoseausgaben.**Methoden** Wie bei `SPAAuth`: `getToken()`, `getAuthorizationUrl({ state })`, `exchangeCode({ code, codeVerifier })`, `refresh()`, `revoke()`, `exportTokens()`, `importTokens(data)`. #### AuthorizationUrlResult Objekt, das von `SPAAuth.getAuthorizationUrl()` und `NativeAppAuth.getAuthorizationUrl()` zurückgegeben wird. Enthält die Autorisierungs-URL und den PKCE-Codeprüfer.**Eigenschaften**`url`: `string` – Die vollständige Autorisierungs-URL, zu der Benutzende umgeleitet werden sollen. `codeVerifier`: `string` – Der PKCE-Codeprüfer, der gespeichert und an `exchange_code()` übergeben werden muss. #### Authentifizierungsausnahmen `FrameioAuthError` wird durch alle Authentifizierungsfehler ausgeweitet. Die Fehler können aus `frameio` importiert werden. | Ausnahme | Beschreibung | | --------------------- | ---------------------------------------------------------------------------------------------------------------------- | | `FrameioAuthError` | Basisfehler für alle Auth-SDK-Fehler. | | `AuthenticationError` | Tokenaustausch oder -aktualisierung fehlgeschlagen.Hat die Eigenschaften `errorCode` und `errorDescription`. | | `TokenExpiredError` | Aktualisierungstoken ist abgelaufen; eine erneute Authentifizierung ist erforderlich. | | `NetworkError` | Eine Netzwerkanfrage ist fehlgeschlagen (Timeout, Verbindungsfehler usw.). | | `RateLimitError` | Von Adobe IMS wurde 429 zurückgegeben, und Wiederholungsversuche sind ausgeschöpft. Hat eine `retryAfter`-Eigenschaft. | | `PKCEError` | PKCE-Verifizierung fehlgeschlagen. | | `ConfigurationError` | Erforderliche Konfiguration fehlt oder ist ungültig. | #### Sammlungen #### client.collections.index(accountId, projectId, \{ ...params }) -> Frameio.CollectionsResponse Sammlungen für ein Projekt auflisten Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.collections.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator,project", after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `projectId`: `Frameio.Uuid` – `request`: `Frameio.CollectionsIndexRequest` `requestOptions`: `Collections.RequestOptions` #### client.collections.show(accountId, collectionId, \{ ...params }) -> Frameio.CollectionResponse Sammlungsdetails anzeigen Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.collections.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator,project", }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `collectionId`: `Frameio.Uuid` – `request`: `Frameio.CollectionsShowRequest` `requestOptions`: `Collections.RequestOptions` #### Kommentare #### client.comments.show(accountId, commentId, \{ ...params }) -> Frameio.CommentWithIncludesResponse Zeigt einen einzelnen Kommentar zu einer Datei an. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "owner", }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `commentId`: `Frameio.Uuid` – `request`: `Frameio.CommentsShowRequest` `requestOptions`: `Comments.RequestOptions` #### client.comments.delete(accountId, commentId) -> void Löscht Kommentar von einem Asset. Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b"); ``` **Parameter** `accountId`: `Frameio.Uuid` – `commentId`: `Frameio.Uuid` – `requestOptions`: `Comments.RequestOptions` #### client.comments.update(accountId, commentId, \{ ...params }) -> Frameio.CommentResponse Aktualisiert Kommentar für gegebenes Asset. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { timestamp_as_timecode: true, data: { annotation: '[{"tool":"rect","color":"#F22237","size":8,"x":0.277726001863933,"y":0.12909555568499534,"w":0.3153168321877913,"h":0.5308131407269339,"ix":0.277726001863933,"iy":0.12909555568499534,"radius":8}]', completed: false, page: 4, text: "This is great!", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `commentId`: `Frameio.Uuid` – `request`: `Frameio.UpdateCommentParams` `requestOptions`: `Comments.RequestOptions` #### client.comments.index(accountId, fileId, \{ ...params }) -> core.Page\ Listet Kommentare für gegebenes Asset auf. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage const response = await client.comments.index( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "owner", after: "", page_size: 10, include_total_count: false, }, ); for await (const item of response) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "owner", after: "", page_size: 10, include_total_count: false, }); while (page.hasNextPage()) { page = page.getNextPage(); } ``` **Parameter** `accountId`: `Frameio.Uuid` – `fileId`: `Frameio.Uuid` – `request`: `Frameio.CommentsIndexRequest` `requestOptions`: `Comments.RequestOptions` #### client.comments.create(accountId, fileId, \{ ...params }) -> Frameio.CommentResponse Erstellt Kommentar zu einer Datei. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { timestamp_as_timecode: true, data: { annotation: '[{"tool":"rect","color":"#F22237","size":8,"x":0.277726001863933,"y":0.12909555568499534,"w":0.3153168321877913,"h":0.5308131407269339,"ix":0.277726001863933,"iy":0.12909555568499534,"radius":8}]', completed: false, page: 4, text: "This is great!", timestamp: "00:00:02:12", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `fileId`: `Frameio.Uuid` – `request`: `Frameio.CreateCommentParams` `requestOptions`: `Comments.RequestOptions` #### client.comments.createAttachment(accountId, commentId, \{ ...params }) -> Frameio.CommentAttachmentResponse Anhang für einen vorhandenen Kommentar erstellen Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { file_size: 1024000, media_type: "image/png", name: "screenshot.png", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `commentId`: `Frameio.Uuid` – `request`: `Frameio.CommentsShowRequest` `requestOptions`: `Comments.RequestOptions` #### client.comments.deleteAttachment(accountId, commentId, attachmentId) -> void Anhang von einem Kommentar löschen. Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b"); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `commentId`: `Frameio.Uuid` – `attachmentId`: `Frameio.Uuid` – `requestOptions`: `Comments.RequestOptions` #### Selbstdefinierte Aktionen #### client.customActions.actionsIndex(accountId, workspaceId, \{ ...params }) -> Frameio.ActionsWithIncludesResponse Aktionen in einem gegebenen Arbeitsbereich auflisten Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.customActions.actionsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `workspaceId`: `Frameio.Uuid` – `request`: `Frameio.ActionsIndexRequest` `requestOptions`: `CustomActions.RequestOptions` #### client.customActions.actionsShow(accountId, actionId, \{ ...params }) -> Frameio.ActionWithIncludesResponse Zeigt Details der Custom Action an. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.customActions.actionsShow("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", }); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `actionId`: `Frameio.Uuid` – `request`: `Frameio.ActionsShowRequest` `requestOptions`: `CustomActions.RequestOptions` #### client.customActions.actionsCreate(accountId, workspaceId, \{ ...params }) -> Frameio.ActionCreateResponse Erstellt eine Custom Action in einem Arbeitsbereich. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.customActions.actionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { description: "customizing our workflow", event: "my.event", name: "First Custom Action", timeout: 7, url: "https://example.com/custom-action", }, }); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `workspaceId`: `Frameio.Uuid` – `request`: `Frameio.ActionCreateParams` `requestOptions`: `CustomActions.RequestOptions` #### client.customActions.actionsUpdate(accountId, actionId, \{ ...params }) -> Frameio.ActionResponse Aktualisiert Details einer Custom Action. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.customActions.actionsUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { active: true, description: "customizing our workflow", event: "my.event", multi_asset: true, name: "First Custom Action", timeout: 7, url: "https://example.com/custom-action", }, }); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `actionId`: `Frameio.Uuid` – `request`: `Frameio.ActionUpdateParams` `requestOptions`: `CustomActions.RequestOptions` #### client.customActions.actionsDelete(accountId, actionId) -> void Löscht eine Custom Action. Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.customActions.actionsDelete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b"); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `actionId`: `Frameio.Uuid` – `requestOptions`: `CustomActions.RequestOptions` #### Dateien #### client.files.list(accountId, folderId, \{ ...params }) -> Frameio.AssetsWithIncludesResponse Listet Dateien in einem gegebenen Ordner auf. Ratenbegrenzungen: 5 Aufrufe pro 1 Sekunde(n) pro account\_user **`usage`** ```ts usage await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "media_links", after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FilesListRequest` `requestOptions`: `Files.RequestOptions` #### client.files.create(accountId, folderId, \{ ...params }) -> Frameio.FileWithUploadUrlsResponse Erstellt neue Datei unter übergeordnetem Ordner. Dieser Endpunkt wurde durch `Datei erstellen (lokaler Upload)` und `Datei erstellen (Remote-Upload)` ersetzt. Ratenbegrenzungen: 5 Aufrufe pro 1 Sekunde(n) pro account\_user **`usage`** ```ts usage await client.files.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { file_size: 1137444, media_type: "image/png", name: "asset.png", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FileCreateParams` `requestOptions`: `Files.RequestOptions` #### client.files.show(accountId, fileId, \{ ...params }) -> Frameio.FileWithIncludesResponse Zeigt Dateidetails an. Beziehen Sie mit dem Abfrageparameter „Einbindung“ selektiv zusätzliche Eigenschaften in die Antwort ein. > **Note** > > Wenn Sie `media_links.original` einbeziehen und die Benutzenden keine Berechtigung zum Herunterladen der Datei haben, wird von diesem Endpunkt der Fehler `403 Forbidden` ausgegeben.Ist der Inhalt nicht zugänglich, weil für diesen Benutzer bzw. diese Benutzerin ein Wasserzeichen erforderlich ist und von den angeforderten media\_links nicht unterstützt wird, ist die Anfrage erfolgreich, aber die nicht unterstützten Medien-Links werden auf Null gesetzt.Ähnlich verhält es sich, wenn ein angeforderter Transcode-Link für eine bestimmte Datei nicht existiert (z. B. das Einbinden von `media_links.video_h264_180` in eine statische Bilddatei) oder die Transkodierung nicht abgeschlossen ist (d. h., der Status der Datei lautet „hochgeladen“ anstatt „transkodiert“); dann wird der Link in der Antwort-Payload ebenfalls auf Null gesetzt.Kurz gesagt, der Client muss Null-Medien-Links elegant verarbeiten. Ratenbegrenzungen: 5 Aufrufe pro 1 Sekunde(n) pro account\_user **`usage`** ```ts usage await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "media_links", }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FilesShowRequest` `requestOptions`: `Files.RequestOptions` #### client.files.delete(accountId, fileId) -> void Löscht Datei anhand der ID. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.files.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b"); ``` **Parameter** `accountId`: `Frameio.Uuid` – `fileId`: `Frameio.Uuid` – `requestOptions`: `Files.RequestOptions` #### client.files.update(accountId, fileId, \{ ...params }) -> Frameio.FileResponse Aktualisiert Dateidetails. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.files.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { name: "asset.png", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `fileId`: `Frameio.Uuid` – `request`: `Frameio.FileUpdateParams` `requestOptions`: `Files.RequestOptions` #### client.files.copy(accountId, fileId, \{ ...params }) -> Frameio.FileCopyResponse Kopiert Datei. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { copy_metadata: true, copy_comments: "none", data: { parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `fileId`: `Frameio.Uuid` – `request`: `Frameio.FileCopyParams` `requestOptions`: `Files.RequestOptions` #### client.files.createRemoteUpload(accountId, folderId, \{ ...params }) -> Frameio.FileRemoteUploadResponse Erstellt durch Remote-Upload unter dem übergeordneten Ordner neue Datei. Ratenbegrenzungen: 5 Aufrufe pro 1 Sekunde(n) pro account\_user **`usage`** ```ts usage await client.files.createRemoteUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { name: "asset.png", source_url: "https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FileCreateRemoteUploadParams` `requestOptions`: `Files.RequestOptions` #### client.files.move(accountId, fileId, \{ ...params }) -> Frameio.FileResponse Verschiebt Datei in einen Ordner oder version\_stack. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.files.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `fileId`: `Frameio.Uuid` – `request`: `Frameio.FileMoveParams` `requestOptions`: `Files.RequestOptions` #### client.files.createLocalUpload(accountId, folderId, \{ ...params }) -> Frameio.FileWithUploadUrlsResponse Erstellt durch lokalen Upload unter dem übergeordneten Ordner neue Datei. Ratenbegrenzungen: 5 Aufrufe pro 1 Sekunde(n) pro account\_user **`usage`** ```ts usage await client.files.createLocalUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { file_size: 1137444, name: "asset.png", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FileCreateLocalUploadParams` `requestOptions`: `Files.RequestOptions` #### client.files.showFileUploadStatus(accountId, fileId) -> Frameio.FileUploadStatusResponse Zeigt Details zum Status des Datei-Uploads an. Ratenbegrenzungen: 5 Aufrufe pro 1 Sekunde(n) pro account\_user **`usage`** ```ts usage await client.files.showFileUploadStatus("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b"); ``` **Parameter** `accountId`: `Frameio.Uuid` – `fileId`: `Frameio.Uuid` – `requestOptions`: `Files.RequestOptions` #### client.files.importFile(accountId, folderId, \{ ...params }) -> Frameio.FileResponse Datei von einem im Konto konfigurierten Speicherort importieren Ratenbegrenzungen: 5 Aufrufe pro 1 Sekunde(n) pro account\_user **`usage`** ```ts usage await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png", name: "asset.png", storage_location: "123e4567-e89b-12d3-a456-426614174000", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FileCreateParams` `requestOptions`: `Files.RequestOptions` #### Ordnerberechtigungen #### client.folderPermissions.folderUserRolesIndex(accountId, folderId, \{ ...params }) -> Frameio.UserRolesResponse Benutzendenrollen für einen gegebenen Ordner auflisten Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.folderPermissions.folderUserRolesIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include_deactivated: true, after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FolderUserRolesIndexRequest` `requestOptions`: `FolderPermissions.RequestOptions` #### client.folderPermissions.folderUserRolesUpdate(accountId, folderId, userId, \{ ...params }) -> Frameio.UpdateUserRolesResponse Benutzendenrollen für den gegebenen Ordner aktualisieren, wenn der Benutzer bzw. die Benutzerin bereits dem Ordner hinzugefügt wurde Wenn Benutzende nicht dem Ordner hinzugefügt wurden, werden sie mit der gegebenen Rolle hinzugefügt. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.folderPermissions.folderUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { role: "editor", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `userId`: `Frameio.Uuid` – `request`: `Frameio.UpdateUserRolesParams` `requestOptions`: `FolderPermissions.RequestOptions` #### client.folderPermissions.delete(accountId, folderId, userId) -> void Benutzende aus einem gegebenen Ordner entfernen Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.folderPermissions.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b"); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `userId`: `Frameio.Uuid` – `requestOptions`: `FolderPermissions.RequestOptions` #### Ordner #### client.folders.show(accountId, folderId, \{ ...params }) -> Frameio.FolderWithIncludesResponse Zeigt Ordnerdetails an. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `projectId`: `Frameio.Uuid` – `request`: `Frameio.FoldersShowRequest` `requestOptions`: `Folders.RequestOptions` #### client.folders.delete(accountId, folderId) -> void Löscht Ordner anhand der ID. Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b"); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `requestOptions`: `Folders.RequestOptions` #### client.folders.update(accountId, folderId, \{ ...params }) -> Frameio.FolderResponse Aktualisiert Ordnerdetails. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { name: "Folder name", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FolderUpdateParams` `requestOptions`: `Folders.RequestOptions` #### client.folders.index(accountId, folderId, \{ ...params }) -> Frameio.AssetsWithIncludesResponse Listet die untergeordneten Elemente im gegebenen Ordner auf. Beziehen Sie mit dem Abfrageparameter „Einbindung“ selektiv zusätzliche Eigenschaften in die Antwort ein. > **Note** > > Wenn Sie `media_links.original` einbinden und Benutzende im entsprechenden Projekt keine Berechtigung zum Herunterladen von Dateien haben, wird von diesem Endpunkt der Fehler `403 Forbidden` ausgegeben. Ist der Inhalt nicht zugänglich, weil für diesen Benutzer bzw. diese Benutzerin ein Wasserzeichen erforderlich ist und von den angeforderten media\_links nicht unterstützt wird, ist die Anfrage erfolgreich, aber die nicht unterstützten Medien-Links werden auf Null gesetzt.Ähnlich verhält es sich, wenn ein angeforderter Transkodierungs-Link für eine bestimmte Datei nicht existiert (z. B. das Einbinden von `media_links.video_h264_180` in eine statische Bilddatei) oder die Transkodierung nicht abgeschlossen ist (d. h., der Status der Datei lautet „hochgeladen“ statt „transkodiert“); dann wird ein Medien-Link in der Antwort-Payload ebenfalls auf Null gesetzt.Kurz gesagt, der Client muss Null-Medien-Links elegant verarbeiten. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "media_links", type: "file,folder,version_stack", after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FolderIndexRequest` `requestOptions`: `Folders.RequestOptions` #### client.folders.copy(accountId, folderId, \{ ...params }) -> Frameio.FolderCopyResponse Kopiert Ordner. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { copy_metadata: true, data: { parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FolderCopyParams` `requestOptions`: `Folders.RequestOptions` #### client.folders.list(accountId, folderId, \{ ...params }) -> Frameio.FoldersWithIncludesResponse Listet Ordner in einem gegebenen Ordner auf. Ratenbegrenzungen: 5 Aufrufe pro 1 Sekunde(n) pro account\_user **`usage`** ```ts usage await client.folders.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FoldersListRequest` `requestOptions`: `Folders.RequestOptions` #### client.folders.create(accountId, folderId, \{ ...params }) -> Frameio.FolderResponse Einen neuen Ordner innerhalb des gegebenen Pfadparameters `folder_id` erstellen Ratenbegrenzungen: 3 Aufrufe pro 1 Sekunde(n) pro account\_user **`usage`** ```ts usage await client.folders.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { name: "Folder name", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FolderCreateParams` `requestOptions`: `Folders.RequestOptions` #### client.folders.move(accountId, folderId, \{ ...params }) -> Frameio.FolderResponse Verschiebt Ordner in einen Ordner. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.folders.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.FolderMoveParams` `requestOptions`: `Folders.RequestOptions` #### Gruppen #### client.groups.index(accountId, \{ ...params }) -> Frameio.GroupsWithIncludesResponse Gruppen im Konto auflisten Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.groups.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", sort: "creator_asc", after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `request`: `Frameio.GroupsIndexRequest` `requestOptions`: `Groups.RequestOptions` #### client.groups.show(accountId, groupId, \{ ...params }) -> Frameio.GroupWithIncludesResponse Gruppendetails anzeigen Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.groups.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", }); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `groupId`: `Frameio.Uuid` – `request`: `Frameio.GroupsShowRequest` `requestOptions`: `Groups.RequestOptions` #### client.groups.create(accountId, \{ ...params }) -> Frameio.GroupResponse Gruppe für das aktuelle Konto erstellen Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.groups.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { emoji: "smile", name: "group-1", }, }); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `request`: `Frameio.CreateGroupParams` `requestOptions`: `Groups.RequestOptions` #### client.groups.update(accountId, groupId, \{ ...params }) -> Frameio.GroupResponse Gruppendetails aktualisieren Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.groups.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { emoji: "smile", name: "group-1", }, }); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `groupId`: `Frameio.Uuid` – `request`: `Frameio.UpdateGroupParams` `requestOptions`: `Groups.RequestOptions` #### Metadaten #### client.metadata.bulkUpdate(accountId, projectId, \{ ...params }) -> void Aktualisiert mehrere Dateien umfassende Metadatenwerte. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { file_ids: ["09b31c2a-04de-464a-a593-643a36ef0d98", "b967fc36-4e18-4b48-a3ab-c790100e2baa"], values: [ { field_definition_id: "ff41ce50-269b-4624-8306-aac10e28ab94", value: [ { id: "e60f47b4-cf8e-4273-96d5-3258a830a0aa", type: "user", }, { id: "24eeaf7e-ce27-4555-bc77-cce39900626d", type: "account_user_group", }, ], }, ], }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `projectId`: `Frameio.Uuid` – `request`: `Frameio.BulkUpdateMetadataParams` `requestOptions`: `Metadata.RequestOptions` #### client.metadata.show(accountId, fileId, \{ ...params }) -> Frameio.MetadataResponse Zeigt die Metadaten einer Datei an. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.metadata.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { show_null: true, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `fileId`: `Frameio.Uuid` – `request`: `Frameio.MetadataShowRequest` `requestOptions`: `Metadata.RequestOptions` #### Metadatenfelder #### client.metadataFields.metadataFieldDefinitionsDelete(accountId, fieldDefinitionId) -> void Löscht selbstdefinierte Felddefinitionen auf Kontoebene. Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.metadataFields.metadataFieldDefinitionsDelete( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", ); ``` **Parameter** `accountId`: `Frameio.Uuid` – `fieldDefinitionId`: `Frameio.Uuid` – `requestOptions`: `MetadataFields.RequestOptions` #### client.metadataFields.metadataFieldDefinitionsUpdate(accountId, fieldDefinitionId, \{ ...params }) -> Frameio.FieldDefinitionResponse Aktualisiert Definitionen selbstdefinierter Felder auf Kontoebene. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.metadataFields.metadataFieldDefinitionsUpdate( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { field_type: "select", field_configuration: { enable_add_new: false, options: [ { display_name: "Option 1", }, { display_name: "Option 2", }, ], }, name: "Updated-Field-Name", }, }, ); ``` **Parameter** `accountId`: `Frameio.Uuid` – `fieldDefinitionId`: `Frameio.Uuid` – `request`: `Frameio.UpdateFieldDefinitionParams` `requestOptions`: `MetadataFields.RequestOptions` #### client.metadataFields.metadataFieldDefinitionsIndex(accountId, \{ ...params }) -> Frameio.FieldDefinitionsWithIncludesResponse Listet Felddefinitionen auf Kontoebene auf. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `request`: `Frameio.MetadataFieldDefinitionsIndexRequest` `requestOptions`: `MetadataFields.RequestOptions` #### client.metadataFields.metadataFieldDefinitionsCreate(accountId, \{ ...params }) -> Frameio.FieldDefinitionResponse Erstellt Felddefinitionen auf Kontoebene. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { field_type: "select", field_configuration: { enable_add_new: false, options: [ { display_name: "Option 1", }, { display_name: "Option 2", }, ], }, name: "Fields definition name", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `request`: `Frameio.CreateFieldDefinitionParams` `requestOptions`: `MetadataFields.RequestOptions` #### Projektberechtigungen #### client.projectPermissions.index(accountId, projectId, \{ ...params }) -> core.Page\", page_size: 10, include_total_count: false, }, ); for await (const item of response) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.projectPermissions.index( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include_deactivated: true, after: "", page_size: 10, include_total_count: false, }, ); while (page.hasNextPage()) { page = page.getNextPage(); } ``` **Parameter** `accountId`: `Frameio.Uuid` – `projectId`: `Frameio.Uuid` – `request`: `Frameio.ProjectPermissionsIndexRequest` `requestOptions`: `ProjectPermissions.RequestOptions` #### client.projectPermissions.delete(accountId, projectId, userId) -> void Entfernt Benutzende aus einem gegebenen Projekt. Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.projectPermissions.delete( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", ); ``` **Parameter** `accountId`: `Frameio.Uuid` – `projectId`: `Frameio.Uuid` – `userId`: `Frameio.Uuid` – `requestOptions`: `ProjectPermissions.RequestOptions` #### client.projectPermissions.projectUserRolesUpdate(accountId, projectId, userId, \{ ...params }) -> Frameio.UpdateUserRolesResponse Aktualisiert Benutzendenrollen für das gegebene Projekt, wenn Benutzende bereits dem Projekt hinzugefügt wurden.Wenn Benutzende nicht dem Projekt hinzugefügt wurden, werden sie mit der gegebenen Rolle hinzugefügt. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.projectPermissions.projectUserRolesUpdate( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { role: "editor", }, }, ); ``` **Parameter** `accountId`: `Frameio.Uuid` – `projectId`: `Frameio.Uuid` – `UserId`: `Frameio.Uuid` – `request`: `Frameio.UpdateUserRolesParams` `requestOptions`: `ProjectPermissions.RequestOptions` #### Projekte #### client.projects.show(accountId, projectId, \{ ...params }) -> Frameio.ProjectWithIncludesResponse Zeigt Projektdetails an. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.projects.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "owner", }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `projectId`: `Frameio.Uuid` – `request`: `Frameio.ProjectsShowRequest` `requestOptions`: `Projects.RequestOptions` #### client.projects.delete(accountId, projectId) -> void Löscht ein Projekt. Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.projects.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b"); ``` **Parameter** `accountId`: `Frameio.Uuid` – `projectId`: `Frameio.Uuid` – `requestOptions`: `Projects.RequestOptions` #### client.projects.update(accountId, projectId, \{ ...params }) -> Frameio.ProjectResponse Aktualisiert Projektdetails. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.projects.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { name: "Project Name", restricted: true, status: "active", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `projectId`: `Frameio.Uuid` – `request`: `Frameio.ProjectUpdateParams` `requestOptions`: `Projects.RequestOptions` #### client.projects.index(accountId, workspaceId, \{ ...params }) -> core.Page\ Projekte in einem gegebenen Arbeitsbereich auflisten. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage const response = await client.projects.index( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "owner", after: "", page_size: 10, include_total_count: false, }, ); for await (const item of response) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.projects.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "owner", after: "", page_size: 10, include_total_count: false, }); while (page.hasNextPage()) { page = page.getNextPage(); } ``` **Parameter** `accountId`: `Frameio.Uuid` – `workspaceId`: `Frameio.Uuid` – `request`: `Frameio.ProjectsIndexRequest` `requestOptions`: `Projects.RequestOptions` #### client.projects.create(accountId, workspaceId, \{ ...params }) -> Frameio.ProjectResponse Erstellt ein Projekt in einem gegebenen Arbeitsbereich. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.projects.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { name: "Project Name", restricted: true, }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `workspaceId`: `Frameio.Uuid` – `request`: `Frameio.ProjectsParams` `requestOptions`: `Projects.RequestOptions` #### client.projects.accountProjectsIndex(accountId, \{ ...params }) -> Frameio.ProjectsWithIncludesResponse Alle Projekte auflisten, auf die authentifizierte Benutzende innerhalb des angegebenen Kontos Zugriff haben. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.projects.accountProjectsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "owner", sort: "name_asc", after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `request`: `Frameio.AccountProjectsIndexRequest` `requestOptions`: `Projects.RequestOptions` #### client.projects.invitedProjectsIndex(accountId, \{ ...params }) -> Frameio.ProjectsWithIncludesResponse Projekte auflisten, zu denen der aktuelle Benutzer bzw. die aktuelle Benutzerin innerhalb des angegebenen Kontos eingeladen wurde, auf die er bzw. sie jedoch keinen Zugriff auf Arbeitsbereich-Ebene hat. Das sind Projekte, bei denen der Benutzer bzw. die Benutzerin projektspezifischen Zugriff als mitwirkende Person hat, jedoch ohne breiter gefasste Team-/Arbeitsbereichsberechtigungen. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.projects.invitedProjectsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "owner", sort: "name_asc", after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.FrameOrAdobeId` – `request`: `Frameio.InvitedProjectsIndexRequest` `requestOptions`: `Projects.RequestOptions` #### Suche #### client.search.search(accountId, \{ ...params }) -> Frameio.SearchResponse Durchsuchen von Assets, Ordnern und Projekten innerhalb eines Kontos Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.search.search("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { engine: "nlp", query: "red car driving on highway", filters: { files_and_version_stacks: true, folders: false, projects: false, }, after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `request`: `Frameio.SearchParams` `requestOptions`: `Search.RequestOptions` #### Freigaben #### client.shares.show(accountId, shareId) -> Frameio.ShareResponse Zeigt eine einzelne Freigabe an. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.shares.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b"); ``` **Parameter** `accountId`: `Frameio.Uuid` – `shareId`: `Frameio.Uuid` – `requestOptions`: `Shares.RequestOptions` #### client.shares.delete(accountId, shareId) -> void Löscht eine Freigabe. Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.shares.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b"); ``` **Parameter** `accountId`: `Frameio.Uuid` – `shareId`: `Frameio.Uuid` – `requestOptions`: `Shares.RequestOptions` #### client.shares.update(accountId, shareId, \{ ...params }) -> Frameio.ShareResponse Aktualisiert eine Freigabe. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.shares.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { access: "public", description: "A descriptive summary of the share", downloading_enabled: true, expiration: "2026-01-22T17:04:53Z", name: "Share Name", passphrase: "as!dfj39sd(*", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `shareId`: `Frameio.Uuid` – `request`: `Frameio.UpdateShareParams` `requestOptions`: `Shares.RequestOptions` #### client.shares.listReviewers(accountId, shareId, \{ ...params }) -> core.Page\ Auflisten von Freigabe-Prüfenden. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage const response = await client.shares.listReviewers( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { after: "", page_size: 10, include_total_count: false, }, ); for await (const item of response) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.shares.listReviewers( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { after: "", page_size: 10, include_total_count: false, }, ); while (page.hasNextPage()) { page = page.getNextPage(); } ``` **Parameter** `accountId`: `Frameio.Uuid` – `shareId`: `Frameio.Uuid` – `request`: `Frameio.SharesListReviewersRequestreParams` `requestOptions`: `Shares.RequestOptions` #### client.shares.addReviewers(accountId, shareId, \{ ...params }) -> void Fügt Prüfende anhand von drei Bezeichnertypen der sicheren Freigabe hinzu: `adobe_user_id`, `email` und `user_id`. Eine Anfrage kann nur einen Bezeichnertyp-Parameter enthalten. `email` ist der einzige Bezeichner, mit dem Prüfende einer Freigabe hinzugefügt werden können, die kein Frame-Konto-Mitglied des Kontos sind, zu dem die Freigabe gehört. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.shares.addReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { message: "Please join my share!", reviewers: { emails: ["email1@domain.com", "email2@domain.com"], }, }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `shareId`: `Frameio.Uuid` – `request`: `Frameio.AddReviewersToShareParams` `requestOptions`: `Shares.RequestOptions` #### client.shares.removeReviewers(accountId, shareId, \{ ...params }) -> void Entfernt Prüfende anhand von drei Bezeichnertypen aus der sicheren Freigabe: `adobe_user_id`, `email` und `user_id`. Eine Anfrage kann nur einen Bezeichnertyp-Parameter enthalten. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.shares.removeReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { reviewers: { adobe_user_ids: ["2A3C1A3D66C621B20A494021@176719f5667c82b4499999.e"], }, }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `shareId`: `Frameio.Uuid` – `request`: `Frameio.RemoveReviewerParams` `requestOptions`: `Shares.RequestOptions` #### client.shares.removeAsset(accountId, shareId, assetId) -> Frameio.RemoveAssetResponse Entfernen eines Assets aus dieser Freigabe, das sich aktuell dort befindet. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.shares.removeAsset( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", ); ``` **Parameter** `accountId`: `Frameio.Uuid` – `shareId`: `Frameio.Uuid` – `assetId`: `Frameio.Uuid` – `requestOptions`: `Shares.RequestOptions` #### client.shares.addAsset(accountId, shareId, \{ ...params }) -> Frameio.AddAssetResponse Fügt neue Asset-Freigabe hinzu. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { asset_id: "0cc1cb59-1d7c-4176-8532-afe099897318", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `shareId`: `Frameio.Uuid` – `request`: `Frameio.AddAssetParams` `requestOptions`: `Shares.RequestOptions` #### client.shares.index(accountId, projectId, \{ ...params }) -> core.Page\ Listet Freigaben in einem Projekt auf. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage const response = await client.shares.index( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { after: "", page_size: 10, include_total_count: false, }, ); for await (const item of response) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.shares.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { after: "", page_size: 10, include_total_count: false, }); while (page.hasNextPage()) { page = page.getNextPage(); } ``` **Parameter** `accountId`: `Frameio.Uuid` – `shareId`: `Frameio.Uuid` – `request`: `Frameio.SharesIndexRequest` `requestOptions`: `Shares.RequestOptions` #### client.shares.create(accountId, projectId, \{ ...params }) -> Frameio.ShareResponse Erstellt Freigabe. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.shares.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { type: "asset", access: "public", asset_ids: ["12eb1446-5736-4f93-85fc-3b636f156211", "f23a3b3e-7b1f-4655-b91a-acf0566e5bb9"], downloading_enabled: true, expiration: "2026-01-22T17:04:53Z", name: "Share Name", passphrase: "as!dfj39sd(*", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `projectId`: `Frameio.Uuid` – `request`: `Frameio.CreateShareParams` `requestOptions`: `Shares.RequestOptions` #### Benutzende #### client.users.show() -> Frameio.ProfileResponse Prüft Details von Benutzenden, die mit dem Bearer-Token verknüpft sind. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.users.show(); ``` **Parameter** `requestOptions`: `Users.RequestOptions` #### Versionsstapel #### client.versionStacks.index(accountId, versionStackId, \{ ...params }) -> Frameio.AssetsWithIncludesResponse Listet die untergeordneten Elemente (Dateien) in einem vorgegebenen Versionsstapel auf. Beziehen Sie mit dem Abfrageparameter „Einbindung“ selektiv zusätzliche Eigenschaften in die Antwort ein. > **Note** > > `Wenn Sie`media\_links.original`einbeziehen und die Benutzenden keine Berechtigung zum Herunterladen von Dateien im entsprechenden Projekt haben, wird von diesem Endpunkt der Fehler`403 Forbidden`ausgegeben.Ist der Inhalt nicht zugänglich, weil für diesen Benutzer bzw. diese Benutzerin ein Wasserzeichen erforderlich ist und von den angeforderten media_links nicht unterstützt wird, ist die Anfrage erfolgreich, aber die nicht unterstützten Medien-Links werden auf Null gesetzt.Ähnlich verhält es sich, wenn ein angeforderter Transkodierungs-Link für eine bestimmte Datei nicht existiert (z. B. Einbinden von`media\_links.video\_h264\_180` in eine statische Bilddatei) oder die Transkodierung nicht abgeschlossen ist (d. h., der Status der Datei lautet „hochgeladen“ anstatt „transkodiert“); dann wird ein Medien-Link in der Antwort-Payload ebenfalls auf Null gesetzt.Kurz gesagt, der Client muss Null-Medien-Links elegant verarbeiten.` Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "media_links", after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `projectId`: `Frameio.Uuid` – `request`: `Frameio.VersionStacksIndexRequest` `requestOptions`: `VersionStacks.RequestOptions` #### client.versionStacks.show(accountId, versionStackId, \{ ...params }) -> Frameio.VersionStackWithIncludesResponse Zeigt Details des Versionsstapels an. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "media_links", }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `versionStackId`: `Frameio.Uuid` – `request`: `Frameio.VersionStacksShowRequest` `requestOptions`: `VersionStacks.RequestOptions` #### client.versionStacks.copy(accountId, versionStackId, \{ ...params }) -> Frameio.VersionStackCopyResponse Kopiert Versionsstapel. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { copy_metadata: true, data: { parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `versionStackId`: `Frameio.Uuid` – `request`: `Frameio.VersionStackCopyParams` `requestOptions`: `VersionStacks.RequestOptions` #### client.versionStacks.list(accountId, folderId, \{ ...params }) -> Frameio.VersionStacksWithIncludesResponse Listet Versionsstapel in einem gegebenen Ordner auf. Ratenbegrenzungen: 5 Aufrufe pro 1 Sekunde(n) pro account\_user **`usage`** ```ts usage await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "media_links", after: "", page_size: 10, include_total_count: false, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.VersionStacksListRequest` `requestOptions`: `VersionStacks.RequestOptions` #### client.versionStacks.create(accountId, folderId, \{ ...params }) -> Frameio.VersionStackWithIncludesResponse Erstellt einen neuen Versionsstapel unter dem übergeordneten Ordner. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { file_ids: ["dd2a3cdd-fc90-41bd-a7b8-8a0447aec6d4", "79fed48a-8372-496e-8dcb-5e959b9b9fcf"], }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.VersionStackCreateParams` `requestOptions`: `VersionStacks.RequestOptions` #### client.versionStacks.move(accountId, versionStackId, \{ ...params }) -> Frameio.VersionStackResponse Verschiebt Versionsstapel in einen Ordner. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `folderId`: `Frameio.Uuid` – `request`: `Frameio.VersionStackMoveParams` `requestOptions`: `VersionStacks.RequestOptions` #### Webhooks #### client.webhooks.index(accountId, workspaceId, \{ ...params }) -> core.Page\ Listet Webhooks für den gegebenen Arbeitsbereich auf. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage const response = await client.webhooks.index( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", after: "", page_size: 10, include_total_count: false, }, ); for await (const item of response) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.webhooks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", after: "", page_size: 10, include_total_count: false, }); while (page.hasNextPage()) { page = page.getNextPage(); } ``` **Parameter** `accountId`: `Frameio.Uuid` – `workspaceId`: `Frameio.Uuid` – `request`: `Frameio.WebhooksIndexRequest` `requestOptions`: `Webhooks.RequestOptions` #### client.webhooks.create(accountId, workspaceId, \{ ...params }) -> Frameio.WebhookCreateResponse Erstellt einen einzelnen Webhook mit Geheimnis. Gültige Ereignisse: `file.created`, `file.deleted`, `file.ready`, `file.updated`, `file.upload.completed`, `file.versioned`, `file.copied`, `folder.created`, `folder.deleted`, `folder.updated`, `folder.copied`, `comment.completed`, `comment.created`, `comment.deleted`, `comment.uncompleted`, `comment.updated`, `customfield.created`, `customfield.updated`, `customfield.deleted`, `metadata.value.updated`, `project.created`, `project.deleted`, `project.updated`, `collection.created`, `collection.updated`, `collection.deleted`, `share.created`, `share.updated`, `share.deleted`, `share.viewed` Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro Konto **`usage`** ```ts usage await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { events: [ "file.created", "file.deleted", "file.ready", "file.updated", "file.upload.completed", "file.versioned", "file.copied", "folder.created", "folder.deleted", "folder.updated", "folder.copied", "comment.completed", "comment.created", "comment.deleted", "comment.uncompleted", "comment.updated", "customfield.created", "customfield.updated", "customfield.deleted", "metadata.value.updated", "project.created", "project.deleted", "project.updated", "collection.created", "collection.updated", "collection.deleted", "share.created", "share.updated", "share.deleted", "share.viewed", ], name: "New Webhook", url: "https://url.example.com", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `workspaceId`: `Frameio.Uuid` – `request`: `Frameio.WebhookCreateParams` `requestOptions`: `Webhooks.RequestOptions` #### client.webhooks.show(accountId, webhookId, \{ ...params }) -> Frameio.WebhookWithIncludesResponse Zeigt Webhook-Details an. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.webhooks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `webhookId`: `Frameio.Uuid` – `request`: `Frameio.WebhooksShowRequest` `requestOptions`: `Webhooks.RequestOptions` #### client.webhooks.delete(accountId, webhookId) -> void Löscht einen Webhook. Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.webhooks.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b"); ``` **Parameter** `accountId`: `Frameio.Uuid` – `webhookId`: `Frameio.Uuid` – `requestOptions`: `Webhooks.RequestOptions` #### client.webhooks.update(accountId, webhookId, \{ ...params }) -> Frameio.WebhookResponse Aktualisiert Webhook-Details. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { active: true, events: [ "file.created", "file.deleted", "file.ready", "file.updated", "file.upload.completed", "file.versioned", "file.copied", "folder.created", "folder.deleted", "folder.updated", "folder.copied", "comment.completed", "comment.created", "comment.deleted", "comment.uncompleted", "comment.updated", "customfield.created", "customfield.updated", "customfield.deleted", "metadata.value.updated", "project.created", "project.deleted", "project.updated", "collection.created", "collection.updated", "collection.deleted", "share.created", "share.updated", "share.deleted", "share.viewed", ], name: "Updated Webhook", url: "https://url.example.com", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – webhookId`: `Frameio.Uuid`–` `request`: `Frameio.WebhookUpdateParams` `requestOptions`: `Webhooks.RequestOptions` #### Arbeitsbereichsberechtigungen #### client.workspacePermissions.index(accountId, workspaceId, \{ ...params }) -> core.Page\ Listet Benutzendenrollen für einen gegebenen Arbeitsbereich auf. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage const response = await client.workspacePermissions.index( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include_deactivated: true, after: "", page_size: 10, include_total_count: false, }, ); for await (const item of response) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.workspacePermissions.index( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include_deactivated: true, after: "", page_size: 10, include_total_count: false, }, ); while (page.hasNextPage()) { page = page.getNextPage(); } ``` **Parameter** `accountId`: `Frameio.Uuid` – `workspaceId`: `Frameio.Uuid` – `request`: `Frameio.WorkspacePermissionsIndexRequest` `requestOptions`: `WorkspacePermissions.RequestOptions` #### client.workspacePermissions.workspaceUserRolesDelete(accountId, workspaceId, userId) -> void Entfernt einen Benutzer bzw. eine Benutzerin aus einem gegebenen Arbeitsbereich. Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.workspacePermissions.workspaceUserRolesDelete( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", ); ``` **Parameter** `accountId`: `Frameio.Uuid` – `workspaceId`: `Frameio.Uuid` – `userId`: `Frameio.Uuid` – `requestOptions`: `WorkspacePermissions.RequestOptions` #### client.workspacePermissions.workspaceUserRolesUpdate(accountId, workspaceId, userId, \{ ...params }) -> Frameio.UpdateUserRolesResponse Aktualisiert Benutzendenrollen für den gegebenen Arbeitsbereich, wenn der Benutzer bzw. die Benutzerin bereits dem Arbeitsbereich hinzugefügt wurde.Wenn der Benutzer bzw. die Benutzerin nicht dem Arbeitsbereich hinzugefügt wurde, wird er bzw. sie mit der gegebenen Rolle hinzugefügt. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.workspacePermissions.workspaceUserRolesUpdate( "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { role: "editor", }, }, ); ``` **Parameter** `accountId`: `Frameio.Uuid` – `workspaceId`: `Frameio.Uuid` – `userId`: `Frameio.Uuid` – `request`: `Frameio.UpdateUserRolesParams` `requestOptions`: `WorkspacePermissions.RequestOptions` #### Arbeitsbereiche #### client.workspaces.show(accountId, workspaceId, \{ ...params }) -> Frameio.WorkspaceWithIncludesResponse Zeigt Arbeitsbereichsdetails an. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.workspaces.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `workspaceId`: `Frameio.Uuid` – `request`: `Frameio.WorkspacesShowRequest` `requestOptions`: `Workspaces.RequestOptions` #### client.workspaces.delete(accountId, workspaceId) -> void Löscht Arbeitsbereich aus Konto. Ratenbegrenzungen: 60 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.workspaces.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b"); ``` **Parameter** `accountId`: `Frameio.Uuid` – `workspaceId`: `Frameio.Uuid` – `requestOptions`: `Workspaces.RequestOptions` #### client.workspaces.update(accountId, workspaceId, \{ ...params }) -> Frameio.WorkspaceResponse Aktualisiert einen Arbeitsbereich. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.workspaces.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { name: "My Workspace", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `workspaceId`: `Frameio.Uuid` – `request`: `Frameio.WorkspaceParams` `requestOptions`: `Workspaces.RequestOptions` #### client.workspaces.index(accountId, \{ ...params }) -> core.Page\ Listet Arbeitsbereiche für ein gegebenes Konto auf. Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage const response = await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", after: "", page_size: 10, include_total_count: false, }); for await (const item of response) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { include: "creator", after: "", page_size: 10, include_total_count: false, }); while (page.hasNextPage()) { page = page.getNextPage(); } ``` **Parameter** `accountId`: `Frameio.Uuid` – `request`: `Frameio.WorkspacesIndexRequest` `requestOptions`: `Workspaces.RequestOptions` #### client.workspaces.create(accountId, \{ ...params }) -> Frameio.WorkspaceResponse Erstellt einen Arbeitsbereich in einem Konto. Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account\_user **`usage`** ```ts usage await client.workspaces.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", { data: { name: "My Workspace", }, }); ``` **Parameter** `accountId`: `Frameio.Uuid` – `request`: `Frameio.WorkspaceParams` `requestOptions`: `Workspaces.RequestOptions` --- ### npm > **Launch** > > Auf [npm](https://www.npmjs.com/package/frameio) anzeigen. ---