TypeScript SDK-Referenz | Frame.io API Documentation

Installation

$ npm i -s frameio

Verwendung

Instanziieren Sie den Client und verwenden Sie ihn mit dem Folgenden:

1 import { FrameioClient } from "frameio";
2 
3 const client = new FrameioClient({ token: "YOUR_TOKEN" });
4 await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
5     data: {
6         field_type: "select",
7         field_configuration: {
8             enable_add_new: false,
9             options: [
10                 {
11                     display_name: "Option 1",
12                 },
13                 {
14                     display_name: "Option 2",
15                 },
16             ],
17         },
18         name: "Fields definition name",
19     },
20 });

Anfrage- und Antworttypen

Alle Anfrage- und Antworttypen werden vom SDK als TypeScript-Schnittstellen exportiert.Importieren Sie sie einfach mit dem folgenden Namespace:

1 import { Frameio } from "frameio";
2 
3 const request: Frameio.UpdateFieldDefinitionParams = {
4     ...
5 };

Ausnahmebehandlung

Wenn die API einen Nichterfolgs-Statuscode zurückgibt (4xx- oder 5xx-Antwort), wird eine Unterklasse des folgenden Fehlers ausgelöst.

1 import { FrameioError } from "frameio";
2 
3 try {
4     await client.metadataFields.metadataFieldDefinitionsCreate(...);
5 } catch (err) {
6     if (err instanceof FrameioError) {
7         console.log(err.statusCode);
8         console.log(err.message);
9         console.log(err.body);
10         console.log(err.rawResponse);
11     }
12 }

Erweitert

Zusätzliche Header

Wenn Sie zusätzliche Header als Teil der Anfrage senden möchten, verwenden Sie die Option für Header-Anfragen.

1 const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2     headers: {
3         'X-Custom-Header': 'custom value'
4     }
5 });

Zusätzliche Parameter für Abfragezeichenfolgen

Falls Sie zusätzliche Abfragezeichenfolgen-Parameter als Teil der Anfrage senden möchten, verwenden Sie die Anfrageoption queryParams.

1 const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2     queryParams: {
3         'customQueryParamKey': 'custom query param value'
4     }
5 });

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.

1 const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2     maxRetries: 0 // override maxRetries at the request level
3 });

Timeouts

Im SDK ist standardmäßig ein Timeout (Zeitüberschreitung) von 60 Sekunden eingestellt.Konfigurieren Sie dieses Verhalten mit der Option timeoutInSeconds.

1 const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
2     timeoutInSeconds: 30 // override timeout to 30s
3 });

Abbrechen von Anfragen

Im SDK können Benutzende Anfragen jederzeit abbrechen, indem sie ein Abbruchsignal übergeben.

1 const controller = new AbortController();
2 const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
3     abortSignal: controller.signal
4 });
5 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.

1 const { data, rawResponse } = await client.metadataFields.metadataFieldDefinitionsCreate(...).withRawResponse();
2 
3 console.log(data);
4 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.

1 import { FrameioClient } from "frameio";
2 
3 const client = new FrameioClient({
4     ...
5     fetcher: // provide your implementation here
6 });

Referenz

Kontoberechtigungen

client.accountPermissions.index(accountId, { ...params }) -> core.Page<Frameio.AccountUserRole>

Listet Benutzendenrollen für ein gegebenes Konto auf.

Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account_user

usage

1 const response = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include_deactivated: true,
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });
7 for await (const item of response) {
8     console.log(item);
9 }
10 
11 // Or you can manually iterate page-by-page
12 let page = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
13     include_deactivated: true,
14     after: "<opaque_cursor>",
15     page_size: 10,
16     include_total_count: false,
17 });
18 while (page.hasNextPage()) {
19     page = page.getNextPage();
20 }

Parameter

accountId: Frameio.Uuid –

request: Frameio.AccountPermissionsIndexRequest

requestOptions: AccountPermissions.RequestOptions

Konten

client.accounts.index({ ...params }) -> core.Page<Frameio.Account>

Listet Konten für den aktuellen Benutzer bzw. die aktuelle Benutzerin auf.

Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account_user

usage

1 const response = await client.accounts.index({
2     after: "<opaque_cursor>",
3     page_size: 10,
4     include_total_count: false,
5 });
6 for await (const item of response) {
7     console.log(item);
8 }
9 
10 // Or you can manually iterate page-by-page
11 let page = await client.accounts.index({
12     after: "<opaque_cursor>",
13     page_size: 10,
14     include_total_count: false,
15 });
16 while (page.hasNextPage()) {
17     page = page.getNextPage();
18 }

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

1 await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "user",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

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

1 import { FrameioClient, ServerToServerAuth } from "frameio";
2 
3 const auth = new ServerToServerAuth({
4     clientId: "YOUR_CLIENT_ID",
5     clientSecret: "YOUR_CLIENT_SECRET",
6 });
7 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. MethodengetToken(): Promise<string> – Gibt einen gültigen Zugriffstoken zurück, der bei Bedarf aktualisiert wird. Übergeben an den Client: new FrameioClient({ token: () => auth.getToken() }). authenticate(): Promise<TokenResponse> – Fordert explizit einen neuen Zugriffstoken an. revoke(): Promise<void> – 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

1 import { randomBytes } from "crypto";
2 import { FrameioClient, WebAppAuth } from "frameio";
3 
4 const auth = new WebAppAuth({
5     clientId: "YOUR_CLIENT_ID",
6     clientSecret: "YOUR_CLIENT_SECRET",
7     redirectUri: "https://myapp.com/callback",
8 });
9 const url = auth.getAuthorizationUrl({ state: randomBytes(24).toString("hex") });
10 // redirect the user to url ...
11 await auth.exchangeCode("CODE_FROM_CALLBACK");
12 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.MethodengetToken(): Promise<string> – 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<TokenResponse> – Eintauschen eines Autorisierungscodes gegen Zugriffs- und Aktualisierungstoken. refresh(): Promise<TokenResponse> – Manuelles Auslösen der Tokenaktualisierung. revoke(): Promise<void> – 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

1 import { randomBytes } from "crypto";
2 import { FrameioClient, SPAAuth } from "frameio";
3 
4 const auth = new SPAAuth({
5     clientId: "YOUR_CLIENT_ID",
6     redirectUri: "https://myapp.com/cb",
7 });
8 const result = await auth.getAuthorizationUrl({ state: randomBytes(24).toString("hex") });
9 // redirect the user to result.url, store result.codeVerifier ...
10 await auth.exchangeCode({ code: "CODE_FROM_CALLBACK", codeVerifier: result.codeVerifier });
11 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.MethodengetToken(): Promise<string> – Gibt einen gültigen Zugriffstoken zurück, der bei Bedarf aktualisiert wird.getAuthorizationUrl({ state }): Promise<AuthorizationUrlResult> – 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<TokenResponse> – Eintauschen eines Autorisierungscodes und PKCE-Prüfers gegen Token. refresh(): Promise<TokenResponse> – Manuelles Auslösen der Tokenaktualisierung.revoke(): Promise<void> – 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

1 import { randomBytes } from "crypto";
2 import { FrameioClient, NativeAppAuth } from "frameio";
3 
4 const auth = new NativeAppAuth({
5     clientId: "YOUR_CLIENT_ID",
6     redirectUri: "myapp://callback",
7 });
8 const result = await auth.getAuthorizationUrl({ state: randomBytes(24).toString("hex") });
9 // open result.url in the system browser, store result.codeVerifier ...
10 await auth.exchangeCode({ code: "CODE_FROM_CALLBACK", codeVerifier: result.codeVerifier });
11 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.Eigenschaftenurl: 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

1 await client.collections.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator,project",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

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

1 await client.collections.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator,project",
3 });

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

1 await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "owner",
3 });

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

1 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

1 await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     timestamp_as_timecode: true,
3     data: {
4         annotation:
5             '[{"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}]',
6         completed: false,
7         page: 4,
8         text: "This is great!",
9     },
10 });

Parameter

accountId: Frameio.Uuid –

commentId: Frameio.Uuid –

request: Frameio.UpdateCommentParams

requestOptions: Comments.RequestOptions

client.comments.index(accountId, fileId, { ...params }) -> core.Page<Frameio.CommentWithIncludes>

Listet Kommentare für gegebenes Asset auf.

Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account_user

usage

1 const response = await client.comments.index(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         include: "owner",
6         after: "<opaque_cursor>",
7         page_size: 10,
8         include_total_count: false,
9     },
10 );
11 for await (const item of response) {
12     console.log(item);
13 }
14 
15 // Or you can manually iterate page-by-page
16 let page = await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
17     include: "owner",
18     after: "<opaque_cursor>",
19     page_size: 10,
20     include_total_count: false,
21 });
22 while (page.hasNextPage()) {
23     page = page.getNextPage();
24 }

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

1 await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     timestamp_as_timecode: true,
3     data: {
4         annotation:
5             '[{"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}]',
6         completed: false,
7         page: 4,
8         text: "This is great!",
9         timestamp: "00:00:02:12",
10     },
11 });

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

1 await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         file_size: 1024000,
4         media_type: "image/png",
5         name: "screenshot.png",
6     },
7 });

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

1 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

1 await client.customActions.actionsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

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

1 await client.customActions.actionsShow("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3 });

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

1 await client.customActions.actionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         description: "customizing our workflow",
4         event: "my.event",
5         name: "First Custom Action",
6         timeout: 7,
7         url: "https://example.com/custom-action",
8     },
9 });

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

1 await client.customActions.actionsUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         active: true,
4         description: "customizing our workflow",
5         event: "my.event",
6         multi_asset: true,
7         name: "First Custom Action",
8         timeout: 7,
9         url: "https://example.com/custom-action",
10     },
11 });

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

1 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

1 await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "media_links",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

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

1 await client.files.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         file_size: 1137444,
4         media_type: "image/png",
5         name: "asset.png",
6     },
7 });

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.

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

1 await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "media_links",
3 });

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

1 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

1 await client.files.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "asset.png",
4     },
5 });

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

1 await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     copy_metadata: true,
3     copy_comments: "none",
4     data: {
5         parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
6     },
7 });

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

1 await client.files.createRemoteUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "asset.png",
4         source_url: "https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png",
5     },
6 });

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

1 await client.files.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
4     },
5 });

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

1 await client.files.createLocalUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         file_size: 1137444,
4         name: "asset.png",
5     },
6 });

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

1 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

1 await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
4         name: "asset.png",
5         storage_location: "123e4567-e89b-12d3-a456-426614174000",
6     },
7 });

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

1 await client.folderPermissions.folderUserRolesIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include_deactivated: true,
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

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

1 await client.folderPermissions.folderUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         role: "editor",
4     },
5 });

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

1 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

1 await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3 });

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

1 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

1 await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "Folder name",
4     },
5 });

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.

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

1 await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "media_links",
3     type: "file,folder,version_stack",
4     after: "<opaque_cursor>",
5     page_size: 10,
6     include_total_count: false,
7 });

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

1 await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     copy_metadata: true,
3     data: {
4         parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
5     },
6 });

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

1 await client.folders.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

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

1 await client.folders.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "Folder name",
4     },
5 });

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

1 await client.folders.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
4     },
5 });

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

1 await client.groups.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3     sort: "creator_asc",
4     after: "<opaque_cursor>",
5     page_size: 10,
6     include_total_count: false,
7 });

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

1 await client.groups.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3 });

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

1 await client.groups.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         emoji: "smile",
4         name: "group-1",
5     },
6 });

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

1 await client.groups.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         emoji: "smile",
4         name: "group-1",
5     },
6 });

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

1 await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         file_ids: ["09b31c2a-04de-464a-a593-643a36ef0d98", "b967fc36-4e18-4b48-a3ab-c790100e2baa"],
4         values: [
5             {
6                 field_definition_id: "ff41ce50-269b-4624-8306-aac10e28ab94",
7                 value: [
8                     {
9                         id: "e60f47b4-cf8e-4273-96d5-3258a830a0aa",
10                         type: "user",
11                     },
12                     {
13                         id: "24eeaf7e-ce27-4555-bc77-cce39900626d",
14                         type: "account_user_group",
15                     },
16                 ],
17             },
18         ],
19     },
20 });

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

1 await client.metadata.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     show_null: true,
3 });

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

1 await client.metadataFields.metadataFieldDefinitionsDelete(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4 );

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

1 await client.metadataFields.metadataFieldDefinitionsUpdate(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         data: {
6             field_type: "select",
7             field_configuration: {
8                 enable_add_new: false,
9                 options: [
10                     {
11                         display_name: "Option 1",
12                     },
13                     {
14                         display_name: "Option 2",
15                     },
16                 ],
17             },
18             name: "Updated-Field-Name",
19         },
20     },
21 );

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

1 await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

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

1 await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         field_type: "select",
4         field_configuration: {
5             enable_add_new: false,
6             options: [
7                 {
8                     display_name: "Option 1",
9                 },
10                 {
11                     display_name: "Option 2",
12                 },
13             ],
14         },
15         name: "Fields definition name",
16     },
17 });

Parameter

accountId: Frameio.Uuid –

request: Frameio.CreateFieldDefinitionParams

requestOptions: MetadataFields.RequestOptions

Projektberechtigungen

client.projectPermissions.index(accountId, projectId, { ...params }) -> core.Page<Frameio.UserRole

Listet Benutzendenrollen für das gegebene Projekt auf.

Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account_user

usage

1 const response = await client.projectPermissions.index(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         include_deactivated: true,
6         after: "<opaque_cursor>",
7         page_size: 10,
8         include_total_count: false,
9     },
10 );
11 for await (const item of response) {
12     console.log(item);
13 }
14 
15 // Or you can manually iterate page-by-page
16 let page = await client.projectPermissions.index(
17     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
18     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
19     {
20         include_deactivated: true,
21         after: "<opaque_cursor>",
22         page_size: 10,
23         include_total_count: false,
24     },
25 );
26 while (page.hasNextPage()) {
27     page = page.getNextPage();
28 }

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

1 await client.projectPermissions.delete(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5 );

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

1 await client.projectPermissions.projectUserRolesUpdate(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5     {
6         data: {
7             role: "editor",
8         },
9     },
10 );

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

1 await client.projects.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "owner",
3 });

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

1 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

1 await client.projects.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "Project Name",
4         restricted: true,
5         status: "active",
6     },
7 });

Parameter

accountId: Frameio.Uuid –

projectId: Frameio.Uuid –

request: Frameio.ProjectUpdateParams

requestOptions: Projects.RequestOptions

client.projects.index(accountId, workspaceId, { ...params }) -> core.Page<Frameio.ProjectWithIncludes>

Projekte in einem gegebenen Arbeitsbereich auflisten.

Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account_user

usage

1 const response = await client.projects.index(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         include: "owner",
6         after: "<opaque_cursor>",
7         page_size: 10,
8         include_total_count: false,
9     },
10 );
11 for await (const item of response) {
12     console.log(item);
13 }
14 
15 // Or you can manually iterate page-by-page
16 let page = await client.projects.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
17     include: "owner",
18     after: "<opaque_cursor>",
19     page_size: 10,
20     include_total_count: false,
21 });
22 while (page.hasNextPage()) {
23     page = page.getNextPage();
24 }

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

1 await client.projects.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "Project Name",
4         restricted: true,
5     },
6 });

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

1 await client.projects.accountProjectsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "owner",
3     sort: "name_asc",
4     after: "<opaque_cursor>",
5     page_size: 10,
6     include_total_count: false,
7 });

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

1 await client.projects.invitedProjectsIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "owner",
3     sort: "name_asc",
4     after: "<opaque_cursor>",
5     page_size: 10,
6     include_total_count: false,
7 });

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

1 await client.search.search("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     engine: "nlp",
3     query: "red car driving on highway",
4     filters: {
5         files_and_version_stacks: true,
6         folders: false,
7         projects: false,
8     },
9     after: "<opaque_cursor>",
10     page_size: 10,
11     include_total_count: false,
12 });

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

1 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

1 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

1 await client.shares.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         access: "public",
4         description: "A descriptive summary of the share",
5         downloading_enabled: true,
6         expiration: "2026-01-22T17:04:53Z",
7         name: "Share Name",
8         passphrase: "as!dfj39sd(*",
9     },
10 });

Parameter

accountId: Frameio.Uuid –

shareId: Frameio.Uuid –

request: Frameio.UpdateShareParams

requestOptions: Shares.RequestOptions

client.shares.listReviewers(accountId, shareId, { ...params }) -> core.Page<Frameio.User>

Auflisten von Freigabe-Prüfenden.

Ratenbegrenzungen: 10 Aufrufe pro 1,00 Minute(n) pro account_user

usage

1 const response = await client.shares.listReviewers(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         after: "<opaque_cursor>",
6         page_size: 10,
7         include_total_count: false,
8     },
9 );
10 for await (const item of response) {
11     console.log(item);
12 }
13 
14 // Or you can manually iterate page-by-page
15 let page = await client.shares.listReviewers(
16     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
17     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
18     {
19         after: "<opaque_cursor>",
20         page_size: 10,
21         include_total_count: false,
22     },
23 );
24 while (page.hasNextPage()) {
25     page = page.getNextPage();
26 }

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

1 await client.shares.addReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         message: "Please join my share!",
4         reviewers: {
5             emails: ["email1@domain.com", "email2@domain.com"],
6         },
7     },
8 });

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

1 await client.shares.removeReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         reviewers: {
4             adobe_user_ids: ["2A3C1A3D66C621B20A494021@176719f5667c82b4499999.e"],
5         },
6     },
7 });

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

1 await client.shares.removeAsset(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5 );

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

1 await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         asset_id: "0cc1cb59-1d7c-4176-8532-afe099897318",
4     },
5 });

Parameter

accountId: Frameio.Uuid –

shareId: Frameio.Uuid –

request: Frameio.AddAssetParams

requestOptions: Shares.RequestOptions

client.shares.index(accountId, projectId, { ...params }) -> core.Page<Frameio.Share>

Listet Freigaben in einem Projekt auf.

Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account_user

usage

1 const response = await client.shares.index(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         after: "<opaque_cursor>",
6         page_size: 10,
7         include_total_count: false,
8     },
9 );
10 for await (const item of response) {
11     console.log(item);
12 }
13 
14 // Or you can manually iterate page-by-page
15 let page = await client.shares.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
16     after: "<opaque_cursor>",
17     page_size: 10,
18     include_total_count: false,
19 });
20 while (page.hasNextPage()) {
21     page = page.getNextPage();
22 }

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

1 await client.shares.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         type: "asset",
4         access: "public",
5         asset_ids: ["12eb1446-5736-4f93-85fc-3b636f156211", "f23a3b3e-7b1f-4655-b91a-acf0566e5bb9"],
6         downloading_enabled: true,
7         expiration: "2026-01-22T17:04:53Z",
8         name: "Share Name",
9         passphrase: "as!dfj39sd(*",
10     },
11 });

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

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

Wenn Siemedia_links.originaleinbeziehen und die Benutzenden keine Berechtigung zum Herunterladen von Dateien im entsprechenden Projekt haben, wird von diesem Endpunkt der Fehler403 Forbiddenausgegeben.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 vonmedia_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

1 await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "media_links",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

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

1 await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "media_links",
3 });

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

1 await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     copy_metadata: true,
3     data: {
4         parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
5     },
6 });

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

1 await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "media_links",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });

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

1 await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         file_ids: ["dd2a3cdd-fc90-41bd-a7b8-8a0447aec6d4", "79fed48a-8372-496e-8dcb-5e959b9b9fcf"],
4     },
5 });

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

1 await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
4     },
5 });

Parameter

accountId: Frameio.Uuid –

folderId: Frameio.Uuid –

request: Frameio.VersionStackMoveParams

requestOptions: VersionStacks.RequestOptions

Webhooks

client.webhooks.index(accountId, workspaceId, { ...params }) -> core.Page<Frameio.WebhookWithIncludes>

Listet Webhooks für den gegebenen Arbeitsbereich auf.

Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account_user

usage

1 const response = await client.webhooks.index(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         include: "creator",
6         after: "<opaque_cursor>",
7         page_size: 10,
8         include_total_count: false,
9     },
10 );
11 for await (const item of response) {
12     console.log(item);
13 }
14 
15 // Or you can manually iterate page-by-page
16 let page = await client.webhooks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
17     include: "creator",
18     after: "<opaque_cursor>",
19     page_size: 10,
20     include_total_count: false,
21 });
22 while (page.hasNextPage()) {
23     page = page.getNextPage();
24 }

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

1 await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         events: [
4             "file.created",
5             "file.deleted",
6             "file.ready",
7             "file.updated",
8             "file.upload.completed",
9             "file.versioned",
10             "file.copied",
11             "folder.created",
12             "folder.deleted",
13             "folder.updated",
14             "folder.copied",
15             "comment.completed",
16             "comment.created",
17             "comment.deleted",
18             "comment.uncompleted",
19             "comment.updated",
20             "customfield.created",
21             "customfield.updated",
22             "customfield.deleted",
23             "metadata.value.updated",
24             "project.created",
25             "project.deleted",
26             "project.updated",
27             "collection.created",
28             "collection.updated",
29             "collection.deleted",
30             "share.created",
31             "share.updated",
32             "share.deleted",
33             "share.viewed",
34         ],
35         name: "New Webhook",
36         url: "https://url.example.com",
37     },
38 });

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

1 await client.webhooks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3 });

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

1 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

1 await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         active: true,
4         events: [
5             "file.created",
6             "file.deleted",
7             "file.ready",
8             "file.updated",
9             "file.upload.completed",
10             "file.versioned",
11             "file.copied",
12             "folder.created",
13             "folder.deleted",
14             "folder.updated",
15             "folder.copied",
16             "comment.completed",
17             "comment.created",
18             "comment.deleted",
19             "comment.uncompleted",
20             "comment.updated",
21             "customfield.created",
22             "customfield.updated",
23             "customfield.deleted",
24             "metadata.value.updated",
25             "project.created",
26             "project.deleted",
27             "project.updated",
28             "collection.created",
29             "collection.updated",
30             "collection.deleted",
31             "share.created",
32             "share.updated",
33             "share.deleted",
34             "share.viewed",
35         ],
36         name: "Updated Webhook",
37         url: "https://url.example.com",
38     },
39 });

Parameter

accountId: Frameio.Uuid –

webhookId: Frameio.Uuid–

request: Frameio.WebhookUpdateParams

requestOptions: Webhooks.RequestOptions

Arbeitsbereichsberechtigungen

client.workspacePermissions.index(accountId, workspaceId, { ...params }) -> core.Page<Frameio.UserRole>

Listet Benutzendenrollen für einen gegebenen Arbeitsbereich auf.

Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account_user

usage

1 const response = await client.workspacePermissions.index(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     {
5         include_deactivated: true,
6         after: "<opaque_cursor>",
7         page_size: 10,
8         include_total_count: false,
9     },
10 );
11 for await (const item of response) {
12     console.log(item);
13 }
14 
15 // Or you can manually iterate page-by-page
16 let page = await client.workspacePermissions.index(
17     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
18     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
19     {
20         include_deactivated: true,
21         after: "<opaque_cursor>",
22         page_size: 10,
23         include_total_count: false,
24     },
25 );
26 while (page.hasNextPage()) {
27     page = page.getNextPage();
28 }

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

1 await client.workspacePermissions.workspaceUserRolesDelete(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5 );

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

1 await client.workspacePermissions.workspaceUserRolesUpdate(
2     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
3     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
4     "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
5     {
6         data: {
7             role: "editor",
8         },
9     },
10 );

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

1 await client.workspaces.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3 });

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

1 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

1 await client.workspaces.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "My Workspace",
4     },
5 });

Parameter

accountId: Frameio.Uuid –

workspaceId: Frameio.Uuid –

request: Frameio.WorkspaceParams

requestOptions: Workspaces.RequestOptions

client.workspaces.index(accountId, { ...params }) -> core.Page<Frameio.WorkspaceWithIncludes>

Listet Arbeitsbereiche für ein gegebenes Konto auf.

Ratenbegrenzungen: 100 Aufrufe pro 1,00 Minute(n) pro account_user

usage

1 const response = await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     include: "creator",
3     after: "<opaque_cursor>",
4     page_size: 10,
5     include_total_count: false,
6 });
7 for await (const item of response) {
8     console.log(item);
9 }
10 
11 // Or you can manually iterate page-by-page
12 let page = await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
13     include: "creator",
14     after: "<opaque_cursor>",
15     page_size: 10,
16     include_total_count: false,
17 });
18 while (page.hasNextPage()) {
19     page = page.getNextPage();
20 }

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

1 await client.workspaces.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
2     data: {
3         name: "My Workspace",
4     },
5 });

Parameter

accountId: Frameio.Uuid –

request: Frameio.WorkspaceParams

requestOptions: Workspaces.RequestOptions

npm

Auf npm anzeigen.