TypeScript SDK リファレンス | Frame.io API Documentation

インストール

npm i -s frameio

使用法

次の方法でクライアントをインスタンス化して使用します：

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",
    },
});

リクエストとレスポンスの型

SDK は、すべてのリクエストとレスポンスの型を TypeScript インターフェイスとして書き出しします。次の名前空間で簡単にインポートできます：

import { Frameio } from "frameio";
const request: Frameio.UpdateFieldDefinitionParams = {
    ...
};

例外処理

API が成功以外のステータスコード（4xx または 5xx レスポンス）を返す場合、次のエラーのサブクラスがスローされます。

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);
    }
}

上級

追加ヘッダー

リクエストの一部として追加のヘッダーを送信したい場合は、headers リクエストオプションを使用してください。

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

追加クエリ文字列パラメーター

リクエストの一部として追加のクエリ文字列パラメーターを送信したい場合は、queryParams リクエストオプションを使用してください。

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

リトライ

SDK は指数バックオフによる自動リトライが組み込まれています。リクエストがリトライ可能とみなされ、リトライ試行回数が設定されたリトライ制限（デフォルト：2）を超えていない限り、リクエストはリトライされます。

次のいずれかの HTTP ステータスコードが返された場合、リクエストはリトライ可能とみなされます：

408（タイムアウト）
429（リクエスト過多）
5XX（内部サーバーエラー）

この動作を設定するには、maxRetries リクエストオプションを使用してください。

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

タイムアウト

SDK のデフォルトタイムアウトは 60 秒です。この動作を設定するには、timeoutInSeconds オプションを使用してください。

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

リクエストの中止

SDK では、中止シグナルを渡すことで、いつでもリクエストを中止できます。

const controller = new AbortController();
const response = await client.metadataFields.metadataFieldDefinitionsCreate(..., {
    abortSignal: controller.signal
});
controller.abort(); // aborts the request

生のレスポンスデータへのアクセス

SDKは、.withRawResponse()メソッドを通じて、ヘッダーを含む生の応答データへのアクセスを提供します。.withRawResponse()メソッドは、dataとrawResponseプロパティを持つオブジェクトに解決されるプロミスを返します。

const { data, rawResponse } = await client.metadataFields.metadataFieldDefinitionsCreate(...).withRawResponse();
console.log(data);
console.log(rawResponse.headers['X-My-Header']);

ランタイム互換性

SDKは以下のランタイムで動作します：

Node.js 18+
Vercel
Cloudflare Workers
Deno v1.25+
Bun 1.0+
React Native

Fetchクライアントのカスタマイズ

SDKは、基盤となるHTTPクライアント / Fetch関数をカスタマイズする方法を提供します。サポートされていない環境で実行している場合、これによりガラスを破ってSDKが動作することを確保する方法を提供します。

import { FrameioClient } from "frameio";
const client = new FrameioClient({
    ...
    fetcher: // provide your implementation here
});

リファレンス

メタデータ

client.metadata.bulkUpdate(accountId, projectId, { ...params }) -> void

複数のファイル全体でメタデータ値を更新します。

レート制限：アカウントユーザーあたり1.00分間に10回の呼び出し

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",
                    },
                ],
            },
        ],
    },
});

Parameters

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.BulkUpdateMetadataParams

requestOptions: Metadata.RequestOptions

client.metadata.show(accountId, fileId, { ...params }) -> Frameio.MetadataResponse

ファイルのメタデータを表示します。

レート制限：アカウントユーザーあたり1.00分間に100回の呼び出し

usage

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

Parameters

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.MetadataShowRequest

requestOptions: Metadata.RequestOptions

メタデータフィールド

client.metadataFields.metadataFieldDefinitionsDelete(accountId, fieldDefinitionId) -> void

アカウントレベルのカスタムフィールド定義を削除します。

レート制限：アカウントユーザーあたり1.00分間に60回の呼び出し

usage

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

パラメータ

accountId: Frameio.Uuid —

fieldDefinitionId: Frameio.Uuid —

requestOptions: MetadataFields.RequestOptions

client.metadataFields.metadataFieldDefinitionsUpdate(accountId, fieldDefinitionId, { ...params }) -> Frameio.FieldDefinitionResponse

アカウントレベルのカスタムフィールド定義を更新します。

制限: アカウントユーザーあたり1.00分間に10回の呼び出し

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",
        },
    },
);

パラメータ

accountId: Frameio.Uuid —

fieldDefinitionId: Frameio.Uuid —

request: Frameio.UpdateFieldDefinitionParams

requestOptions: MetadataFields.RequestOptions

client.metadataFields.metadataFieldDefinitionsIndex(accountId, { ...params }) -> Frameio.FieldDefinitionsWithIncludesResponse

アカウントレベルのフィールド定義をリストします。

制限: アカウントユーザーあたり1.00分間に100回の呼び出し

usage

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

パラメータ

accountId: Frameio.Uuid —

request: Frameio.MetadataFieldDefinitionsIndexRequest

requestOptions: MetadataFields.RequestOptions

client.metadataFields.metadataFieldDefinitionsCreate(accountId, { ...params }) -> Frameio.FieldDefinitionResponse

アカウントレベルのフィールド定義を作成します。

制限: アカウントユーザーあたり1.00分間に10回の呼び出し

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",
    },
});

パラメータ

accountId: Frameio.Uuid —

request: Frameio.CreateFieldDefinitionParams

requestOptions: MetadataFields.RequestOptions

プロジェクト権限

指定されたプロジェクトのユーザーロールをリストします。

制限: アカウントユーザーあたり1.00分間に100回の呼び出し

usage

const response = await client.projectPermissions.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        include_deactivated: true,
        after: "<opaque_cursor>",
        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: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
while (page.hasNextPage()) {
    page = page.getNextPage();
}

パラメータ

</frameio.userroleU000022>

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.ProjectPermissionsIndexRequest

requestOptions: ProjectPermissions.RequestOptions </Accordion>

client.projectPermissions.delete(accountId, projectId, userId) -> void

指定されたプロジェクトからユーザーを削除します。

制限: アカウントユーザーあたり1.00分間に60回の呼び出し

usage

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

パラメータ

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

userId: Frameio.Uuid —

requestOptions: ProjectPermissions.RequestOptions

client.projectPermissions.projectUserRolesUpdate(accountId, projectId, userId, { ...params }) -> Frameio.UpdateUserRolesResponse

ユーザーが既にプロジェクトに追加されている場合、指定されたプロジェクトのユーザーロールを更新します。ユーザーがプロジェクトに追加されていない場合、指定されたロールでユーザーが追加されます。

レート制限：アカウントユーザーあたり1分間に10回の呼び出し

usage

await client.projectPermissions.projectUserRolesUpdate(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        data: {
            role: "editor",
        },
    },
);

Parameters

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

UserId: Frameio.Uuid —

request: Frameio.UpdateUserRolesParams

requestOptions: ProjectPermissions.RequestOptions

</AccordionGroup>

プロジェクト

client.projects.show(accountId, projectId, { ...params }) -> Frameio.ProjectWithIncludesResponse

プロジェクトの詳細を表示します。

レート制限：アカウントユーザーあたり1分間に100回の呼び出し

usage

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

Parameters

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.ProjectsShowRequest

requestOptions: Projects.RequestOptions

client.projects.delete(accountId, projectId) -> void

プロジェクトを削除します。

レート制限：アカウントユーザーあたり1分間に60回の呼び出し

usage

await client.projects.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Parameters

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

requestOptions: Projects.RequestOptions

client.projects.update(accountId, projectId, { ...params }) -> Frameio.ProjectResponse

プロジェクトの詳細を更新します。

レート制限：アカウントユーザーあたり1分間に10回の呼び出し

usage

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

Parameters

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.ProjectUpdateParams

requestOptions: Projects.RequestOptions

指定されたWorkspace内のプロジェクトを一覧表示します。

レート制限：アカウントユーザーあたり1分間に100回の呼び出し

usage

const response = await client.projects.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        include: "owner",
        after: "<opaque_cursor>",
        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: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Parameters

</frameio.projectwithincludes>

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.ProjectsIndexRequest

requestOptions: Projects.RequestOptions </Accordion>

client.projects.create(accountId, workspaceId, { ...params }) -> Frameio.ProjectResponse

指定されたWorkspace内にプロジェクトを作成します。

レート制限：アカウントユーザーあたり1分間に10回の呼び出し

usage

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

Parameters

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.ProjectsParams

requestOptions: Projects.RequestOptions

</AccordionGroup>

フォルダー

client.folders.show(accountId, folderId, { ...params }) -> Frameio.FolderWithIncludesResponse

フォルダーの詳細を表示します。

レート制限：account_userあたり1.00分間に100回の呼び出し

usage

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

Parameters

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.FoldersShowRequest

requestOptions: Folders.RequestOptions

client.folders.delete(accountId, folderId) -> void

IDによってフォルダーを削除します。

レート制限：account_userあたり1.00分間に60回の呼び出し

usage

await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Parameters

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

requestOptions: Folders.RequestOptions

client.folders.update(accountId, folderId, { ...params }) -> Frameio.FolderResponse

フォルダーの詳細を更新します。

レート制限：account_userあたり1.00分間に10回の呼び出し

usage

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

Parameters

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderUpdateParams

requestOptions: Folders.RequestOptions

client.folders.index(accountId, folderId, { ...params }) -> Frameio.AssetsWithIncludesResponse

指定されたフォルダー内の子要素を一覧表示します。

includeクエリパラメータを使用して、レスポンスに追加のプロパティを選択的に含めることができます。

media_links.originalを含めて、ユーザーが対応するプロジェクト内のファイルをダウンロードする権限を持たない場合、このエンドポイントは403 Forbiddenエラーで応答します。このユーザーに透かしが必要でコンテンツにアクセスできず、要求されたmedia_linksでサポートされていない場合、リクエストは成功しますが、サポートされていないメディアリンクはnullに設定されます。同様に、要求されたトランスコードリンクが特定のファイルに存在しない場合（例：静的画像ファイルにmedia_links.video_h264_180を含める）、またはトランスコード処理が完了していない場合（つまり、ファイルのステータスが「transcoded」ではなく「uploaded」）、メディアリンクもレスポンスペイロードでnullに設定されます。つまり、クライアントはnullメディアリンクを適切に処理する必要があります。

レート制限：account_userあたり1.00分間に100回の呼び出し

usage

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

Parameters

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderIndexRequest

requestOptions: Folders.RequestOptions

client.folders.copy(accountId, folderId, { ...params }) -> Frameio.FolderCopyResponse

フォルダーをコピーします。

レート制限：account_userあたり1.00分間に10回の呼び出し

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",
    },
});

パラメーター

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderCopyParams

requestOptions: Folders.RequestOptions

client.folders.list(accountId, folderId, { ...params }) -> Frameio.FoldersWithIncludesResponse

指定されたフォルダー内のフォルダーをリストします。

レート制限：アカウントユーザーあたり1秒間に5回のコール

usage

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

パラメーター

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FoldersListRequest

requestOptions: Folders.RequestOptions

client.folders.create(accountId, folderId, { ...params }) -> Frameio.FolderResponse

指定されたfolder_idパスパラメーター内に新しいフォルダーを作成します。

レート制限：アカウントユーザーあたり1秒間に3回のコール

usage

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

パラメーター

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderCreateParams

requestOptions: Folders.RequestOptions

client.folders.move(accountId, folderId, { ...params }) -> Frameio.FolderResponse

フォルダーをフォルダーに移動します。

レート制限：アカウントユーザーあたり1.00分間に10回のコール

usage

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

パラメーター

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FolderMoveParams

requestOptions: Folders.RequestOptions

バージョンスタック

client.versionStacks.index(accountId, versionStackId, { ...params }) -> Frameio.AssetsWithIncludesResponse

指定されたバージョンスタック内の子（ファイル）をリストします。

includeクエリパラメーターを使用して、応答に追加のプロパティを選択的に含めます。

media_links.originalを含め、ユーザーが対応するプロジェクト内のファイルをダウンロードする権限を持たない場合、このエンドポイントは403 Forbiddenエラーで応答します。このユーザーに対して透かしが必要でコンテンツにアクセスできず、要求されたmedia_linksでサポートされていない場合、リクエストは成功しますが、サポートされていないメディアリンクはnullに設定されます。同様に、要求されたトランスコードリンクが特定のファイルに存在しない場合（例：静的画像ファイルにmedia_links.video_h264_180を含める）またはトランスコード処理が完了していない場合（つまり、ファイルのステータスが「transcoded」ではなく「uploaded」の場合）、メディアリンクも応答ペイロードでnullに設定されます。要するに、クライアントはnullのメディアリンクを適切に処理する必要があります。

レート制限：アカウントユーザーあたり1.00分間に100回のコール

usage

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

パラメーター

accountId: Frameio.Uuid —

projectId: Frameio.Uuid —

request: Frameio.VersionStacksIndexRequest

requestOptions: VersionStacks.RequestOptions

client.versionStacks.show(accountId, versionStackId, { ...params }) -> Frameio.VersionStackWithIncludesResponse

バージョンスタックの詳細を表示します。

レート制限：アカウントユーザーあたり1.00分間に100回のコール

usage

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

パラメーター

accountId: Frameio.Uuid —

versionStackId: Frameio.Uuid —

request: Frameio.VersionStacksShowRequest

requestOptions: VersionStacks.RequestOptions

client.versionStacks.copy(accountId, versionStackId, { ...params }) -> Frameio.VersionStackCopyResponse

バージョンスタックをコピーします。

レート制限：アカウントユーザーあたり1.00分間に10回の呼び出し

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",
    },
});

パラメーター

accountId: Frameio.Uuid —

versionStackId: Frameio.Uuid —

request: Frameio.VersionStackCopyParams

requestOptions: VersionStacks.RequestOptions

client.versionStacks.list(accountId, folderId, { ...params }) -> Frameio.VersionStacksWithIncludesResponse

指定されたフォルダー内のバージョンスタックをリスト表示します。

レート制限：アカウントユーザーあたり1秒間に5回の呼び出し

usage

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

パラメーター

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.VersionStacksListRequest

requestOptions: VersionStacks.RequestOptions

client.versionStacks.create(accountId, folderId, { ...params }) -> Frameio.VersionStackWithIncludesResponse

親フォルダーの下に新しいバージョンスタックを作成します。

レート制限：アカウントユーザーあたり1.00分間に10回の呼び出し

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"],
    },
});

パラメーター

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.VersionStackCreateParams

requestOptions: VersionStacks.RequestOptions

client.versionStacks.move(accountId, versionStackId, { ...params }) -> Frameio.VersionStackResponse

バージョンスタックをフォルダーに移動します。

レート制限：アカウントユーザーあたり1.00分間に10回の呼び出し

usage

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

パラメーター

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.VersionStackMoveParams

requestOptions: VersionStacks.RequestOptions

アカウント権限

指定されたアカウントのユーザーロールをリスト表示します。

レート制限：アカウントユーザーあたり1.00分間に100回の呼び出し

usage

const response = await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    include_deactivated: true,
    after: "<opaque_cursor>",
    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: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

パラメーター

</frameio.accountuserrole>

accountId: Frameio.Uuid —

request: Frameio.AccountPermissionsIndexRequest

requestOptions: AccountPermissions.RequestOptions </Accordion> </AccordionGroup>

Accounts

現在のユーザーのアカウントをリスト表示します。

レート制限：アカウント_user あたり 1.00 分間あたり 100 回の呼び出し

usage

const response = await client.accounts.index({
    after: "<opaque_cursor>",
    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: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Parameters

</frameio.account>

request: Frameio.AccountsIndexRequest

requestOptions: Accounts.RequestOptions </Accordion> </AccordionGroup>

client.comments.show(accountId, commentId, { ...params }) -> Frameio.CommentWithIncludesResponse

ファイル上の単一のコメントを表示します。

レート制限：アカウント_user あたり 1.00 分間あたり 100 回の呼び出し

usage

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

Parameters

accountId: Frameio.Uuid —

commentId: Frameio.Uuid —

request: Frameio.CommentsShowRequest

requestOptions: Comments.RequestOptions

client.comments.delete(accountId, commentId) -> void

アセットからコメントを削除します。

レート制限：アカウント_user あたり 1.00 分間あたり 60 回の呼び出し

usage

await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Parameters

accountId: Frameio.Uuid —

commentId: Frameio.Uuid —

requestOptions: Comments.RequestOptions

client.comments.update(accountId, commentId, { ...params }) -> Frameio.CommentResponse

指定されたアセット上のコメントを更新します。

レート制限：アカウント_user あたり 1.00 分間あたり 10 回の呼び出し

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!",
    },
});

Parameters

accountId: Frameio.Uuid —

commentId: Frameio.Uuid —

request: Frameio.UpdateCommentParams

requestOptions: Comments.RequestOptions

指定されたアセット上のコメントをリストします。

レート制限：アカウント_user あたり 1.00 分間あたり 100 回の呼び出し

usage

const response = await client.comments.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        include: "owner",
        after: "<opaque_cursor>",
        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: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Parameters

</frameio.commentwithincludes>

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.CommentsIndexRequest

requestOptions: Comments.RequestOptions </Accordion>

client.comments.create(accountId, fileId, { ...params }) -> Frameio.CommentResponse

ファイル上にコメントを作成します。

レート制限：アカウント_user あたり 1.00 分間あたり 100 回の呼び出し

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",
    },
});

Parameters

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.CreateCommentParams

requestOptions: Comments.RequestOptions

</AccordionGroup>

Webhook

指定されたワークスペースのWebhookを一覧表示します。

レート制限：アカウントユーザーあたり1.00分間に100回の呼び出し

usage

const response = await client.webhooks.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        include: "creator",
        after: "<opaque_cursor>",
        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: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

パラメーター

</frameio.webhookwithincludes>

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WebhooksIndexRequest

requestOptions: Webhooks.RequestOptions </Accordion>

client.webhooks.create(accountId, workspaceId, { ...params }) -> Frameio.WebhookCreateResponse

シークレット付きの単一のWebhookを作成します。

有効なイベント：

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

レート制限：アカウントあたり1.00分間に10回の呼び出し

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",
    },
});

パラメーター

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WebhookCreateParams

requestOptions: Webhooks.RequestOptions

client.webhooks.show(accountId, webhookId, { ...params }) -> Frameio.WebhookWithIncludesResponse

Webhookの詳細を表示します。

レート制限：アカウントユーザーあたり1.00分間に100回の呼び出し

usage

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

パラメーター

accountId: Frameio.Uuid —

webhookId: Frameio.Uuid —

request: Frameio.WebhooksShowRequest

requestOptions: Webhooks.RequestOptions

client.webhooks.delete(accountId, webhookId) -> void

Webhookを削除します。

レート制限：アカウントユーザーあたり1.00分間に60回の呼び出し

usage

await client.webhooks.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

パラメーター

accountId: Frameio.Uuid —

webhookId: Frameio.Uuid —

requestOptions: Webhooks.RequestOptions

client.webhooks.update(accountId, webhookId, { ...params }) -> Frameio.WebhookResponse

Webhookの詳細を更新します。

レート制限：アカウントユーザーあたり1.00分間に10回の呼び出し

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",
    },
});

パラメーター

accountId: Frameio.Uuid —

webhookId: Frameio.Uuid—

request: Frameio.WebhookUpdateParams

requestOptions: Webhooks.RequestOptions

</AccordionGroup>

Workspaceの権限

指定されたWorkspaceのユーザーロールを一覧表示します。

レート制限：アカウントユーザーあたり1.00分間に100回のコール

usage

const response = await client.workspacePermissions.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        include_deactivated: true,
        after: "<opaque_cursor>",
        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: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Parameters

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WorkspacePermissionsIndexRequest

requestOptions: WorkspacePermissions.RequestOptions</frameio.userrole> </Accordion>

client.workspacePermissions.workspaceUserRolesDelete(accountId, workspaceId, userId) -> void

指定されたWorkspaceからユーザーを削除します。

レート制限：アカウントユーザーあたり1.00分間に60回のコール

usage

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

Parameters

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

userId: Frameio.Uuid —

requestOptions: WorkspacePermissions.RequestOptions

client.workspacePermissions.workspaceUserRolesUpdate(accountId, workspaceId, userId, { ...params }) -> Frameio.UpdateUserRolesResponse

ユーザーがすでにWorkspaceに追加されている場合、指定されたWorkspaceのユーザーロールを更新します。ユーザーがWorkspaceに追加されていない場合、指定されたロールでユーザーが追加されます。

レート制限：アカウントユーザーあたり1.00分間に10回のコール

usage

await client.workspacePermissions.workspaceUserRolesUpdate(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        data: {
            role: "editor",
        },
    },
);

Parameters

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

userId: Frameio.Uuid —

request: Frameio.UpdateUserRolesParams

requestOptions: WorkspacePermissions.RequestOptions

</AccordionGroup>

ワークスペース

client.workspaces.show(accountId, workspaceId, { ...params }) -> Frameio.WorkspaceWithIncludesResponse

Workspaceの詳細を表示します。

レート制限：アカウントユーザーあたり1.00分間に100回のコール

usage

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

Parameters

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WorkspacesShowRequest

requestOptions: Workspaces.RequestOptions

client.workspaces.delete(accountId, workspaceId) -> void

アカウントからWorkspaceを削除します。

レート制限：アカウントユーザーあたり1.00分間に60回のコール

usage

await client.workspaces.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Parameters

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

requestOptions: Workspaces.RequestOptions

client.workspaces.update(accountId, workspaceId, { ...params }) -> Frameio.WorkspaceResponse

Workspaceを更新します。

レート制限：アカウントユーザーあたり1.00分間に10回のコール

usage

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

Parameters

accountId: Frameio.Uuid —

workspaceId: Frameio.Uuid —

request: Frameio.WorkspaceParams

requestOptions: Workspaces.RequestOptions

指定されたアカウントのWorkspaceを一覧表示します。

レート制限：アカウント_ユーザーあたり1.00分間に100回のコール

usage

const response = await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
    include: "creator",
    after: "<opaque_cursor>",
    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: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Parameters

accountId: Frameio.Uuid —

request: Frameio.WorkspacesIndexRequest

requestOptions: Workspaces.RequestOptions</frameio.workspacewithincludes> </Accordion>

client.workspaces.create(accountId, { ...params }) -> Frameio.WorkspaceResponse

アカウントからWorkspaceを作成します。

レート制限：アカウント_ユーザーあたり1.00分間に10回のコール

usage

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

Parameters

accountId: Frameio.Uuid —

request: Frameio.WorkspaceParams

requestOptions: Workspaces.RequestOptions

</AccordionGroup>

client.shares.show(accountId, shareId) -> Frameio.ShareResponse

単一の共有を表示します。

レート制限：アカウント_ユーザーあたり1.00分間に100回のコール

usage

await client.shares.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Parameters

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

requestOptions: Shares.RequestOptions

client.shares.delete(accountId, shareId) -> void

共有を削除します。

レート制限：アカウント_ユーザーあたり1.00分間に60回のコール

usage

await client.shares.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Parameters

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

requestOptions: Shares.RequestOptions

client.shares.update(accountId, shareId, { ...params }) -> Frameio.ShareResponse

共有を更新します。

レート制限：アカウント_ユーザーあたり1.00分間に10回のコール

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(*",
    },
});

Parameters

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.UpdateShareParams

requestOptions: Shares.RequestOptions

共有レビュー担当者を一覧表示します。

レート制限：アカウント_ユーザーあたり1.00分間に10回のコール

usage

const response = await client.shares.listReviewers(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        after: "<opaque_cursor>",
        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: "<opaque_cursor>",
        page_size: 10,
        include_total_count: false,
    },
);
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Parameters

accountId: Frameio.Uuid —

shareId: Frameio.Uuid —

request: Frameio.SharesListReviewersRequestreParams

requestOptions: Shares.RequestOptions</frameio.user> </Accordion>

client.shares.addReviewers(accountId, shareId, { ...params }) -> void

adobe_user_id、email、user_idの3つの識別子タイプでセキュアな共有にレビュー担当者を追加します。

リクエストには1つの識別子タイプパラメータのみを含めることができます。

emailは、共有が属するアカウントにFrameアカウントメンバーがいないレビュー担当者を共有に追加できる唯一の識別子です。

レート制限：アカウントユーザーあたり1。00分間に10回のコール

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"],
        },
    },
});

Parameters

accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

request：Frameio.AddReviewersToShareParams

requestOptions：Shares.RequestOptions

client.shares.removeReviewers(accountId, shareId, { ...params }) -> void

adobe_user_id、email、user_idの3つの識別子タイプでセキュア共有からレビュー担当者を削除します。

リクエストには1つの識別子タイプパラメータのみを含めることができます。

レート制限：アカウントユーザーあたり1。00分間に10回のコール

usage

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

Parameters

accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

request：Frameio.RemoveReviewerParams

requestOptions：Shares.RequestOptions

client.shares.removeAsset(accountId, shareId, assetId) -> Frameio.RemoveAssetResponse

共有に現在あるアセットをその共有から削除します。

レート制限：アカウントユーザーあたり1。00分間に10回のコール

usage

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

Parameters

accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

assetId：Frameio.Uuid —

requestOptions：Shares.RequestOptions

client.shares.addAsset(accountId, shareId, { ...params }) -> Frameio.AddAssetResponse

新しいアセット共有を追加します。

レート制限：アカウントユーザーあたり1。00分間に10回のコール

usage

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

Parameters

accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

request：Frameio.AddAssetParams

requestOptions：Shares.RequestOptions

プロジェクトの共有を一覧表示します。

レート制限：アカウントユーザーあたり1。00分間に100回のコール

usage

const response = await client.shares.index(
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    {
        after: "<opaque_cursor>",
        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: "<opaque_cursor>",
    page_size: 10,
    include_total_count: false,
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}

Parameters

accountId：Frameio.Uuid —

shareId：Frameio.Uuid —

request：Frameio.SharesIndexRequest

requestOptions：Shares.RequestOptions</frameio.share> </Accordion>

client.shares.create(accountId, projectId, { ...params }) -> Frameio.ShareResponse

共有を作成します。

レート制限：アカウントユーザーあたり1。00分間に10回のコール

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(*",
    },
});

Parameters

accountId：Frameio.Uuid —

projectId：Frameio.Uuid —

request：Frameio.CreateShareParams

requestOptions：Shares.RequestOptions

</AccordionGroup>

ファイル

client.files.list(accountId, folderId, { ...params }) -> Frameio.AssetsWithIncludesResponse

指定されたフォルダー内のファイルを一覧表示します。

レート制限：account_userあたり1秒間に5回

usage

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

パラメータ

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FilesListRequest

requestOptions：Files.RequestOptions

client.files.create(accountId, folderId, { ...params }) -> Frameio.FileWithUploadUrlsResponse

親フォルダーの下に新しいファイルを作成します。ファイルを作成（ローカルアップロード）とファイルを作成（リモートアップロード）がこのエンドポイントに置き換わりました。

レート制限：account_userあたり1秒間に5回

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",
    },
});

パラメータ

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FileCreateParams

requestOptions：Files.RequestOptions

client.files.show(accountId, fileId, { ...params }) -> Frameio.FileWithIncludesResponse

ファイルの詳細を表示します。

includeクエリパラメータを使用して、応答に追加のプロパティを選択的に含めることができます。

media_links.originalを含めて、ユーザーがファイルをダウンロードする権限を持たない場合、このエンドポイントは403 Forbiddenエラーで応答します。このユーザーに対して透かしが必要で、リクエストされたmedia_linksでサポートされていないためにコンテンツにアクセスできない場合、リクエストは成功しますが、サポートされていないメディアリンクはnullに設定されます。同様に、特定のファイルに対してリクエストされたトランスコードリンクが存在しない場合（例：静的画像ファイルでmedia_links.video_h264_180を含める）、またはトランスコード処理が完了していない場合（つまり、ファイルのステータスが「transcoded」ではなく「uploaded」）、リンクも応答ペイロードでnullに設定されます。つまり、クライアントはnullのメディアリンクを適切に処理する必要があります。

レート制限：account_userあたり1秒間に5回

usage

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

パラメータ

accountId：Frameio.Uuid —

folderId：Frameio.Uuid —

request：Frameio.FilesShowRequest

requestOptions：Files.RequestOptions

client.files.delete(accountId, fileId) -> void

IDでファイルを削除します。

レート制限：account_userあたり1.00分間に100回

usage

await client.files.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

パラメータ

accountId：Frameio.Uuid —

fileId：Frameio.Uuid —

requestOptions：Files.RequestOptions

client.files.update(accountId, fileId, { ...params }) -> Frameio.FileResponse

ファイルの詳細を更新します。

レート制限：account_userあたり1.00分間に100回

usage

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

パラメータ

accountId：Frameio.Uuid —

fileId：Frameio.Uuid —

request：Frameio.FileUpdateParams

requestOptions：Files.RequestOptions

client.files.copy(accountId, fileId, { ...params }) -> Frameio.FileCopyResponse

ファイルをコピー。

レート制限：account_userあたり1.00分間に100回の呼び出し

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",
    },
});

Parameters

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.FileCopyParams

requestOptions: Files.RequestOptions

client.files.createRemoteUpload(accountId, folderId, { ...params }) -> Frameio.FileRemoteUploadResponse

リモートアップロードで親フォルダーの下に新しいファイルを作成。

レート制限：account_userあたり1秒間に5回の呼び出し

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",
    },
});

Parameters

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FileCreateRemoteUploadParams

requestOptions: Files.RequestOptions

client.files.move(accountId, fileId, { ...params }) -> Frameio.FileResponse

ファイルをフォルダーまたはversion_stackに移動。

レート制限：account_userあたり1.00分間に100回の呼び出し

usage

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

Parameters

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

request: Frameio.FileMoveParams

requestOptions: Files.RequestOptions

client.files.createLocalUpload(accountId, folderId, { ...params }) -> Frameio.FileWithUploadUrlsResponse

ローカルアップロードで親フォルダーの下に新しいファイルを作成。

レート制限：account_userあたり1秒間に5回の呼び出し

usage

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

Parameters

accountId: Frameio.Uuid —

folderId: Frameio.Uuid —

request: Frameio.FileCreateLocalUploadParams

requestOptions: Files.RequestOptions

client.files.showFileUploadStatus(accountId, fileId) -> Frameio.FileUploadStatusResponse

ファイルアップロードステータスの詳細を表示。

レート制限：account_userあたり1秒間に5回の呼び出し

usage

await client.files.showFileUploadStatus("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");

Parameters

accountId: Frameio.Uuid —

fileId: Frameio.Uuid —

requestOptions: Files.RequestOptions

ユーザー

client.users.show() -> Frameio.ProfileResponse

ベアラートークンに関連付けられたユーザーの詳細を確認。

レート制限：account_userあたり1.00分間に100回の呼び出し

usage

await client.users.show();

Parameters

requestOptions: Users.RequestOptions

npm

npmで表示