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

インストール

1 pip install frameio

使用方法

クライアントをインスタンス化し、次とともに使用します。

1 from frameio import (
2     Frameio,
3     SelectDefinitionParamsFieldConfiguration,
4     SelectDefinitionParamsFieldConfigurationOptionsItem,
5 )
6 from frameio.metadata_fields import CreateFieldDefinitionParamsData_Select
7 
8 client = Frameio(
9     token="YOUR_TOKEN",
10 )
11 client.metadata_fields.metadata_field_definitions_create(
12     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
13     data=CreateFieldDefinitionParamsData_Select(
14         field_configuration=SelectDefinitionParamsFieldConfiguration(
15             enable_add_new=False,
16             options=[
17                 SelectDefinitionParamsFieldConfigurationOptionsItem(
18                     display_name="Option 1",
19                 ),
20                 SelectDefinitionParamsFieldConfigurationOptionsItem(
21                     display_name="Option 2",
22                 ),
23             ],
24         ),
25         name="Fields definition name",
26     ),
27 )

非同期クライアント

この SDK は、非同期クライアントを書き出すので、ユーザーは、API への非ブロッキング呼び出しを行うことができます。このクライアントに渡す Async httpx クライアントクラスを構成する場合は、httpx.Client() ではなく httpx.AsyncClient() を使用します（例：このクライアントの httpx_client パラメーターの場合）。

1 import asyncio
2 
3 from frameio import (
4     AsyncFrameio,
5     SelectDefinitionParamsFieldConfiguration,
6     SelectDefinitionParamsFieldConfigurationOptionsItem,
7 )
8 from frameio.metadata_fields import CreateFieldDefinitionParamsData_Select
9 
10 client = AsyncFrameio(
11     token="YOUR_TOKEN",
12 )
13 
14 
15 async def main() -> None:
16     await client.metadata_fields.metadata_field_definitions_create(
17         account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
18         data=CreateFieldDefinitionParamsData_Select(
19             field_configuration=SelectDefinitionParamsFieldConfiguration(
20                 enable_add_new=False,
21                 options=[
22                     SelectDefinitionParamsFieldConfigurationOptionsItem(
23                         display_name="Option 1",
24                     ),
25                     SelectDefinitionParamsFieldConfigurationOptionsItem(
26                         display_name="Option 2",
27                     ),
28                 ],
29             ),
30             name="Fields definition name",
31         ),
32     )
33 
34 
35 asyncio.run(main())

例外処理

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

1 from frameio.core.api_error import ApiError
2 
3 try:
4     client.metadata_fields.metadata_field_definitions_create(...)
5 except ApiError as e:
6     print(e.status_code)
7     print(e.body)

ページネーション

ページネーションされたリクエストは、SyncPager または AsyncPager を返します。これらは、基盤となるオブジェクトのジェネレーターとして使用できます。

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 response = client.project_permissions.index(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     page_size=10,
10     include_total_count=False,
11 )
12 for item in response:
13     yield item
14 # alternatively, you can paginate page-by-page
15 for page in response.iter_pages():
16     yield page

高度

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

この SDK では、.with_raw_response プロパティを通じて、raw レスポンスデータ（ヘッダーを含む）にアクセスできます。.with_raw_response プロパティは、.headers および .data 属性にアクセスするために使用できる「raw」クライアントを返します。

1 from frameio import Frameio
2 
3 client = Frameio(
4     ...,
5 )
6 response = (
7     client.metadata_fields.with_raw_response.metadata_field_definitions_create(
8         ...
9     )
10 )
11 print(response.headers)  # access the response headers
12 print(response.data)  # access the underlying object
13 pager = client.project_permissions.index(...)
14 print(pager.response.headers)  # access the response headers for the first page
15 for item in pager:
16     print(item)  # access the underlying object(s)
17 for page in pager.iter_pages():
18     print(page.response.headers)  # access the response headers for each page
19     for item in page:
20         print(item)  # access the underlying object(s)

再試行

この SDK には、指数バックオフでの自動的な再試行が搭載されています。リクエストは、再試行可能と見なされる限り、再試行され、再試行の回数が設定された再試行制限より大きくはなっていません（デフォルト：2）。
次のいずれかの HTTP ステータスコードが返されると、リクエストは再試行可能と見なされます。

408（タイムアウト）
429（リクエストが多すぎます）
5xx（内部サーバーエラー）

この動作を設定するには、max_retries リクエストオプションを使用します。

1 client.metadata_fields.metadata_field_definitions_create(..., request_options={
2     "max_retries": 1
3 })

タイムアウト

この SDK のデフォルトでは、60 秒のタイムアウトです。これは、クライアントまたはリクエストレベルでタイムアウトオプションで設定できます。

1 from frameio import Frameio
2 
3 client = Frameio(
4     ...,
5     timeout=20.0,
6 )
7 
8 
9 # Override timeout for a specific method
10 client.metadata_fields.metadata_field_definitions_create(..., request_options={
11     "timeout_in_seconds": 1
12 })

カスタムクライアント

httpx クライアントをオーバーライドして、ユースケース用にカスタマイズできます。一般的なユースケースには、プロキシおよびトランスポートのサポートが含まれます。

1 import httpx
2 from frameio import Frameio
3 
4 client = Frameio(
5     ...,
6     httpx_client=httpx.Client(
7         proxy="http://my.test.proxy.example.com",
8         transport=httpx.HTTPTransport(local_address="0.0.0.0"),
9     ),
10 )

リファレンス

メタデータ

client.metadata.bulk_update(...) -> AsyncHttpResponse[None]

複数のファイルにわたってメタデータ値を更新します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.metadata import (
3     BulkUpdateMetadataParamsData,
4     BulkUpdateMetadataParamsDataValuesItem,
5 )
6 
7 client = Frameio(
8     token="YOUR_TOKEN",
9 )
10 client.metadata.bulk_update(
11     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
12     project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
13     data=BulkUpdateMetadataParamsData(
14         file_ids=[
15             "09b31c2a-04de-464a-a593-643a36ef0d98",
16             "b967fc36-4e18-4b48-a3ab-c790100e2baa",
17         ],
18         values=[
19             BulkUpdateMetadataParamsDataValuesItem(
20                 field_definition_id="ff41ce50-269b-4624-8306-aac10e28ab94",
21                 value=[
22                     {
23                         "id": "e60f47b4-cf8e-4273-96d5-3258a830a0aa",
24                         "type": "user",
25                     },
26                     {
27                         "id": "24eeaf7e-ce27-4555-bc77-cce39900626d",
28                         "type": "account_user_group",
29                     },
30                 ],
31             )
32         ],
33     ),
34 )

パラメーター

account_id：Uuid —

project_id：Uuid —

data：BulkUpdateMetadataParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.metadata.show(...) -> AsyncHttpResponse[MetadataResponse]

ファイルのメタデータを表示します。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.metadata.show(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     show_null=True,
10 )

パラメーター

account_id：Uuid —

file_id：Uuid —

show_null：typing.Optional[bool] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

メタデータフィールド

client.metadata_fields.metadata_field_definitions_delete(...) -> AsyncHttpResponse[None]

アカウントレベルのカスタムフィールド定義を削除します。レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.metadata_fields.metadata_field_definitions_delete(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     field_definition_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター

account_id：Uuid —

field_definition_id：Uuid —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.metadata_fields.metadata_field_definitions_update(...) -> AsyncHttpResponse[FieldDefinitionResponse]

アカウントレベルのカスタムフィールド定義を更新します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import (
2     Frameio,
3     UpdateSelectDefinitionParamsFieldConfiguration,
4     UpdateSelectDefinitionParamsFieldConfigurationOptionsItem,
5 )
6 from frameio.metadata_fields import UpdateFieldDefinitionParamsData_Select
7 
8 client = Frameio(
9     token="YOUR_TOKEN",
10 )
11 client.metadata_fields.metadata_field_definitions_update(
12     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
13     field_definition_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
14     data=UpdateFieldDefinitionParamsData_Select(
15         field_configuration=UpdateSelectDefinitionParamsFieldConfiguration(
16             enable_add_new=False,
17             options=[
18                 UpdateSelectDefinitionParamsFieldConfigurationOptionsItem(
19                     display_name="Option 1",
20                 ),
21                 UpdateSelectDefinitionParamsFieldConfigurationOptionsItem(
22                     display_name="Option 2",
23                 ),
24             ],
25         ),
26         name="Updated-Field-Name",
27     ),
28 )

パラメーター

account_id：Uuid —

field_definition_id：Uuid —

data：typing.Optional[UpdateFieldDefinitionParamsData]

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.metadata_fields.metadata_field_definitions_index(...) -> AsyncHttpResponse[FieldDefinitionsWithIncludesResponse]

アカウントレベルのフィールド定義をリストします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.metadata_fields.metadata_field_definitions_index(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     after="<opaque_cursor>",
9     page_size=10,
10     include_total_count=False,
11 )

パラメーター

account_id：Uuid —

include：typing.Optional[typing.Literal[“creator”]] —

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.metadata_fields.metadata_field_definitions_create(...) -> AsyncHttpResponse[FieldDefinitionResponse]

アカウントレベルのフィールド定義を作成します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import (
2     Frameio,
3     SelectDefinitionParamsFieldConfiguration,
4     SelectDefinitionParamsFieldConfigurationOptionsItem,
5 )
6 from frameio.metadata_fields import CreateFieldDefinitionParamsData_Select
7 
8 client = Frameio(
9     token="YOUR_TOKEN",
10 )
11 client.metadata_fields.metadata_field_definitions_create(
12     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
13     data=CreateFieldDefinitionParamsData_Select(
14         field_configuration=SelectDefinitionParamsFieldConfiguration(
15             enable_add_new=False,
16             options=[
17                 SelectDefinitionParamsFieldConfigurationOptionsItem(
18                     display_name="Option 1",
19                 ),
20                 SelectDefinitionParamsFieldConfigurationOptionsItem(
21                     display_name="Option 2",
22                 ),
23             ],
24         ),
25         name="Fields definition name",
26     ),
27 )

パラメーター

account_id：Uuid —

data：typing.Optional[CreateFieldDefinitionParamsData]

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

プロジェクト権限

client.project_permissions.index(...) -> AsyncPager[UserRole, UserRolesResponse]

特定のプロジェクトのユーザーロールをリストします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 response = client.project_permissions.index(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     include_deactivated=True,
10     after="<opaque_cursor>",
11     page_size=10,
12     include_total_count=False,
13 )
14 for item in response:
15     yield item
16 # alternatively, you can paginate page-by-page
17 for page in response.iter_pages():
18     yield page

パラメーター

account_id：Uuid —

project_id：Uuid —

include_deactivated：typing.Optional[bool] — 無効化されたユーザーをレスポンスに含めることをサポートします。デフォルトは false です。

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

メモ：この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.project_permissions.delete(...) -> AsyncHttpResponse[None]

特定のプロジェクトからユーザーを削除します。レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.project_permissions.delete(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     user_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10 )

パラメーター

account_id：Uuid —

project_id：Uuid —

user_id：Uuid —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.project_permissions.project_user_roles_update(...) -> AsyncHttpResponse[UpdateUserRolesResponse]

ユーザーが既にプロジェクトに追加されている場合は、指定されたプロジェクトのユーザーロールを更新します。プロジェクトに追加されていないユーザーは、指定されたロールで追加されます。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio, UpdateUserRolesParamsData
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.project_permissions.project_user_roles_update(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     user_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=UpdateUserRolesParamsData(
11         role="editor",
12     ),
13 )

パラメーター

account_id：Uuid —

project_id：Uuid —

user_id：Uuid —

data： UpdateUserRolesParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

プロジェクト

client.projects.show(...) -> AsyncHttpResponse[ProjectWithIncludesResponse]

プロジェクトの詳細を表示します。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.projects.show(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター account_id：Uuid —

project_id：Uuid —

include：typing.Optional[typing.Literal["owner"]] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.projects.delete(...) -> AsyncHttpResponse[None]

プロジェクトを削除します。レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.projects.delete(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター account_id：Uuid —

project_id：Uuid —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.projects.update(...) -> AsyncHttpResponse[ProjectResponse]

プロジェクトの詳細を更新します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.projects import ProjectUpdateParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.projects.update(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=ProjectUpdateParamsData(
11         name="Project Name",
12         restricted=True,
13         status="active",
14     ),
15 )

パラメーター account_id：Uuid —

project_id：Uuid —

data：ProjectUpdateParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.projects.index(...) -> AsyncPager[ProjectWithIncludes, ProjectsWithIncludesResponse]

特定のワークスペース内のプロジェクトをリストします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 response = client.projects.index(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     after="<opaque_cursor>",
10     page_size=10,
11     include_total_count=False,
12 )
13 for item in response:
14     yield item
15 # alternatively, you can paginate page-by-page
16 for page in response.iter_pages():
17     yield page

パラメーター account_id：Uuid —

workspace_id：Uuid —

include：typing.Optional[typing.Literal["owner"]] —

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] — include_total_count: typing.Optional[IncludeTotalCount]` —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.projects.create(...) -> AsyncHttpResponse[ProjectResponse]

特定のワークスペースにプロジェクトを作成します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.projects import ProjectParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.projects.create(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=ProjectParamsData(
11         name="Project Name",
12         restricted=True,
13     ),
14 )

パラメーター account_id：Uuid —

workspace_id：Uuid —

data：ProjectParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

フォルダー

client.folders.show(...) -> AsyncHttpResponse[FolderWithIncludesResponse]

フォルダーの詳細を表示します。
レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.folders.show(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     include="creator",
10 )

パラメーター

account_id：Uuid —

folder_id：Uuid —

include：typing.Optional[AssetInclude] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.folders.delete(...) -> AsyncHttpResponse[None]

id でフォルダーを削除します。レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.folders.delete(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター

account_id：Uuid —

folder_id：Uuid —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.folders.update(...) -> AsyncHttpResponse[FolderResponse]

フォルダーの詳細を更新します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.folders import FolderUpdateParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.folders.update(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=FolderUpdateParamsData(
11         name="Folder name",
12     ),
13 )

パラメーター

account_id：Uuid —

folder_id：Uuid —

data： FolderUpdateParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.folders.index(...) -> AsyncHttpResponse[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

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.folders.index(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     include="media_links",
10     type="file,folder,version_stack",
11     after="<opaque_cursor>",
12     page_size=10,
13     include_total_count=False,
14 )

パラメーター

account_id：Uuid —

folder_id：Uuid —

include：typing.Optional[FileWithMediaLinksInclude] —

type：typing.Optional[ChildrenType] —

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.folders.copy(...) -> AsyncHttpResponse[FolderCopyResponse]

フォルダーをコピーします。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.folders import FolderCopyParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.folders.copy(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     copy_metadata=True,
11     data=FolderCopyParamsData(
12         parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
13     ),
14 )

パラメーター

account_id：Uuid —

folder_id：Uuid —

copy_metadata：typing.Optional[bool] — フォルダーとともにメタデータ値をコピーするかどうか

data：typing.Optional[FolderCopyParamsData]

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.folders.list(...) -> AsyncHttpResponse[FoldersWithIncludesResponse]

特定のフォルダー内のフォルダーをリストします。レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.folders.list(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     include="creator",
10     after="<opaque_cursor>",
11     page_size=10,
12     include_total_count=False,
13 )

パラメーター

account_id：Uuid —

folder_id：Uuid —

include：typing.Optional[AssetInclude] —

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.folders.create(...) -> AsyncHttpResponse[FolderResponse]

指定された folder_id パスパラメーター内に新しいフォルダーを作成します。レート制限：account_user あたり 1 秒ごとに 3 呼び出し

usage

1 from frameio import Frameio
2 from frameio.folders import FolderCreateParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.folders.create(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=FolderCreateParamsData(
11         name="Folder name",
12     ),
13 )

パラメーター

account_id：Uuid —

folder_id：Uuid —

data： FolderCreateParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.folders.move(...) -> AsyncHttpResponse[FolderResponse]

フォルダーを特定のフォルダーに移動します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.folders import FolderMoveParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.folders.move(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=FolderMoveParamsData(
11         parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
12     ),
13 )

パラメーター

account_id：Uuid —

folder_id：Uuid —

data： FolderMoveParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

バージョンスタック

client.version_stacks.index(...) -> AsyncHttpResponse[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

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.version_stacks.index(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     version_stack_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     include="media_links",
10     after="<opaque_cursor>",
11     page_size=10,
12     include_total_count=False,
13 )

パラメーター

account_id：Uuid —

version_stack_id：Uuid —

include：typing.Optional[FileWithMediaLinksInclude] —

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.version_stacks.show(...) -> AsyncHttpResponse[VersionStackWithIncludesResponse]

バージョンスタックの詳細を表示します。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.version_stacks.show(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     version_stack_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     include="media_links",
10 )

パラメーター

account_id：Uuid —

version_stack_id：Uuid —

include：typing.Optional[VersionStacksShowRequestInclude] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.version_stacks.copy(...) -> AsyncHttpResponse[VersionStackCopyResponse]

バージョンスタックをコピーします。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.version_stacks import VersionStackCopyParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.version_stacks.copy(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     version_stack_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     copy_metadata=True,
11     data=VersionStackCopyParamsData(
12         parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
13     ),
14 )

パラメーター

account_id：Uuid —

version_stack_id：Uuid —

copy_metadata：typing.Optional[bool] — バージョンスタックとともにメタデータ値をコピーするかどうか

data：typing.Optional[VersionStackCopyParamsData]

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.version_stacks.list(...) -> AsyncHttpResponse[VersionStacksWithIncludesResponse]

特定のフォルダー内のバージョンスタックをリストします。レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.version_stacks.list(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     include="media_links",
10     after="<opaque_cursor>",
11     page_size=10,
12     include_total_count=False,
13 )

パラメーター

account_id：Uuid —

folder_id：Uuid —

include：typing.Optional[FileWithMediaLinksInclude] —

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.version_stacks.create(...) -> AsyncHttpResponse[VersionStackWithIncludesResponse]

親フォルダーの下に新しいバージョンスタックを作成します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.version_stacks import VersionStackCreateParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.version_stacks.create(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=VersionStackCreateParamsData(
11         file_ids=[
12             "dd2a3cdd-fc90-41bd-a7b8-8a0447aec6d4",
13             "79fed48a-8372-496e-8dcb-5e959b9b9fcf",
14         ],
15     ),
16 )

パラメーター

account_id：Uuid —

folder_id：Uuid —

data： VersionStackCreateParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.version_stacks.move(...) -> AsyncHttpResponse[VersionStackResponse]

バージョンスタックをフォルダーに移動します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.version_stacks import VersionStackMoveParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.version_stacks.move(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     version_stack_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=VersionStackMoveParamsData(
11         parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
12     ),
13 )

パラメーター

account_id：Uuid —

version_stack_id：Uuid —

data： VersionStackMoveParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

アカウント権限

client.account_permissions.index(...) -> AsyncPager[AccountUserRole, AccountUserRolesResponse]

特定のアカウントのユーザーロールをリストします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 response = client.account_permissions.index(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     include_deactivated=True,
9     after="<opaque_cursor>",
10     page_size=10,
11     include_total_count=False,
12 )
13 for item in response:
14     yield item
15 # alternatively, you can paginate page-by-page
16 for page in response.iter_pages():
17     yield page

パラメーター

account_id：Uuid —

include_deactivated：typing.Optional[bool] — 無効化されたユーザーをレスポンスに含めることをサポートします。デフォルトは false です。

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

アカウント

client.accounts.index(...) -> AsyncPager[Account, AccountsResponse]

現在のユーザーのアカウントをリストします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 response = client.accounts.index(
7     after="<opaque_cursor>",
8     page_size=10,
9     include_total_count=False,
10 )
11 for item in response:
12     yield item
13 # alternatively, you can paginate page-by-page
14 for page in response.iter_pages():
15     yield page

パラメーター

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.comments.show(...) -> AsyncHttpResponse[CommentWithIncludesResponse]

ファイルへの単一コメントを表示します。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.comments.show(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     comment_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     include="owner",
10 )

パラメーター

account_id：Uuid —

comment_id：Uuid —

include：typing.Optional[CommentsShowRequestInclude] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.comments.delete(...) -> AsyncHttpResponse[None]

アセットからコメントを削除します。レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.comments.delete(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     comment_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター

account_id：Uuid —

comment_id：Uuid —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.comments.update(...) -> AsyncHttpResponse[CommentResponse]

指定されたアセットへのコメントを更新します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.comments import UpdateCommentParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.comments.update(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     comment_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     timestamp_as_timecode=True,
11     data=UpdateCommentParamsData(
12         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}]',
13         completed=False,
14         page=4,
15         text="This is great!",
16     ),
17 )

パラメーター

account_id：Uuid —

comment_id：Uuid —

data： UpdateCommentParamsData

timestamp_as_timecode：typing.Optional[bool] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.comments.index(...) -> AsyncPager[CommentWithIncludes, CommentsWithIncludesResponse]

特定のアセットへのコメントをリストします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 response = client.comments.index(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     include="owner",
10     after="<opaque_cursor>",
11     page_size=10,
12     include_total_count=False,
13 )
14 for item in response:
15     yield item
16 # alternatively, you can paginate page-by-page
17 for page in response.iter_pages():
18     yield page

パラメーター

account_id：Uuid —

file_id：Uuid —

include：typing.Optional[CommentInclude] —

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.comments.create(...) -> AsyncHttpResponse[CommentResponse]

ファイルへのコメントを作成します。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 from frameio.comments import CreateCommentParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.comments.create(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     timestamp_as_timecode=True,
11     data=CreateCommentParamsData(
12         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}]',
13         completed=False,
14         page=4,
15         text="This is great!",
16         timestamp="00:00:02:12",
17     ),
18 )

パラメーター

account_id：Uuid —

file_id：Uuid —

data： CreateCommentParamsData

timestamp_as_timecode：typing.Optional[bool] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

Webhook

client.webhooks.index(...) -> AsyncPager[WebhookWithIncludes, WebhooksWithIncludesResponse]

指定されたワークスペースの webhook をリストします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 response = client.webhooks.index(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     after="<opaque_cursor>",
10     page_size=10,
11     include_total_count=False,
12 )
13 for item in response:
14     yield item
15 # alternatively, you can paginate page-by-page
16 for page in response.iter_pages():
17     yield page

パラメーター

account_id：Uuid —

workspace_id：Uuid —

include：typing.Optional[typing.Literal[“creator”]] —

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.webhooks.create(...) -> AsyncHttpResponse[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

1 from frameio import Frameio
2 from frameio.webhooks import WebhookCreateParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.webhooks.create(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=WebhookCreateParamsData(
11         events=[
12             "file.created",
13             "file.deleted",
14             "file.ready",
15             "file.updated",
16             "file.upload.completed",
17             "file.versioned",
18             "file.copied",
19             "folder.created",
20             "folder.deleted",
21             "folder.updated",
22             "folder.copied",
23             "comment.completed",
24             "comment.created",
25             "comment.deleted",
26             "comment.uncompleted",
27             "comment.updated",
28             "customfield.created",
29             "customfield.updated",
30             "customfield.deleted",
31             "metadata.value.updated",
32             "project.created",
33             "project.deleted",
34             "project.updated",
35             "collection.created",
36             "collection.updated",
37             "collection.deleted",
38             "share.created",
39             "share.updated",
40             "share.deleted",
41             "share.viewed",
42         ],
43         name="New Webhook",
44         url="https://url.example.com",
45     ),
46 )

パラメーター

account_id：Uuid —

workspace_id：Uuid —

data： WebhookCreateParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.webhooks.show(...) -> AsyncHttpResponse[WebhookWithIncludesResponse]

Webhook の詳細を表示します。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.webhooks.show(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     webhook_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター

account_id：Uuid —

webhook_id：Uuid —

include：typing.Optional[typing.Literal[“creator”]] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.webhooks.delete(...) -> AsyncHttpResponse[None]

Webhook を削除します。レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.webhooks.delete(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     webhook_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター

account_id：Uuid —

webhook_id：Uuid —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.webhooks.update(...) -> AsyncHttpResponse[WebhookResponse]

Webhook の詳細を更新します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.webhooks import WebhookUpdateParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.webhooks.update(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     webhook_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=WebhookUpdateParamsData(
11         active=True,
12         events=[
13             "file.created",
14             "file.deleted",
15             "file.ready",
16             "file.updated",
17             "file.upload.completed",
18             "file.versioned",
19             "file.copied",
20             "folder.created",
21             "folder.deleted",
22             "folder.updated",
23             "folder.copied",
24             "comment.completed",
25             "comment.created",
26             "comment.deleted",
27             "comment.uncompleted",
28             "comment.updated",
29             "customfield.created",
30             "customfield.updated",
31             "customfield.deleted",
32             "metadata.value.updated",
33             "project.created",
34             "project.deleted",
35             "project.updated",
36             "collection.created",
37             "collection.updated",
38             "collection.deleted",
39             "share.created",
40             "share.updated",
41             "share.deleted",
42             "share.viewed",
43         ],
44         name="Updated Webhook",
45         url="https://url.example.com",
46     ),
47 )

パラメーター

account_id：Uuid —

webhook_id：Uuid —

data： WebhookUpdateParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

ワークスペースの権限

client.workspace_permissions.index(...) -> AsyncPager[UserRole, UserRolesResponse]

特定のワークスペースのユーザーロールをリストします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 response = client.workspace_permissions.index(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     include_deactivated=True,
10     after="<opaque_cursor>",
11     page_size=10,
12     include_total_count=False,
13 )
14 for item in response:
15     yield item
16 # alternatively, you can paginate page-by-page
17 for page in response.iter_pages():
18     yield page

パラメーター

account_id：Uuid —

workspace_id：Uuid —

includ_deactivated：typing.Optional[bool] — 無効化されたユーザーをレスポンスに含めることをサポートします。デフォルトは false です。

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.workspace_permissions.workspace_user_roles_delete(...) -> AsyncHttpResponse[None]

特定のワークスペースからユーザーを削除します。レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.workspace_permissions.workspace_user_roles_delete(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     user_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10 )

パラメーター

account_id：Uuid —

workspace_id：Uuid —

user_id：Uuid —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.workspace_permissions.workspace_user_roles_update(...) -> AsyncHttpResponse[UpdateUserRolesResponse]

ユーザーが既にワークスペースに追加されている場合は、指定されたワークスペースのユーザーロールを更新します。ワークスペースに追加されていないユーザーは、指定されたロールで追加されます。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio, UpdateUserRolesParamsData
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.workspace_permissions.workspace_user_roles_update(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     user_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=UpdateUserRolesParamsData(
11         role="editor",
12     ),
13 )

パラメーター

account_id：Uuid —

workspace_id：Uuid—

user_id：Uuid —

data：UpdateUserRolesParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

ワークスペース

client.workspaces.show(...) -> AsyncHttpResponse[WorkspaceWithIncludesResponse]

ワークスペースの詳細を表示します。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.workspaces.show(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター

account_id：Uuid —

workspace_id：Uuid —

include：typing.Optional[typing.Literal[“creator”]] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.workspaces.delete(...) -> AsyncHttpResponse[None]

アカウントからワークスペースを削除します。レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.workspaces.delete(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター

account_id：Uuid —

workspace_id：Uuid —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.workspaces.update(...) -> AsyncHttpResponse[WorkspaceResponse]

ワークスペースを更新します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio, WorkspaceParamsData
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.workspaces.update(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     data=WorkspaceParamsData(
10         name="My Workspace",
11     ),
12 )

パラメーター

account_id：Uuid —

workspace_id：Uuid —

data： WorkspaceParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.workspaces.index(...) -> AsyncPager[WorkspaceWithIncludes, WorkspacesWithIncludesResponse]

特定のアカウントのワークスペースをリストします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 response = client.workspaces.index(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     after="<opaque_cursor>",
9     page_size=10,
10     include_total_count=False,
11 )
12 for item in response:
13     yield item
14 # alternatively, you can paginate page-by-page
15 for page in response.iter_pages():
16     yield page

パラメーター

account_id：Uuid —

workspace_id：Uuid —

include：typing.Optional[typing.Literal[“owner”]] —

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

`page_size“：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.workspaces.create(...) -> AsyncHttpResponse[WorkspaceResponse]

アカウントからワークスペースを作成します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio, WorkspaceParamsData
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.workspaces.create(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     data=WorkspaceParamsData(
9         name="My Workspace",
10     ),
11 )

パラメーター

account_id：Uuid —

data：WorkspaceParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.shares.show(...) -> AsyncHttpResponse[ShareResponse]

単一共有を表示します。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.shares.show(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター

account_id：Uuid —

share_id：Uuid —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.shares.delete(...) -> AsyncHttpResponse[None]

共有を削除します。レート制限：account_user あたり 1.00 分ごとに 60 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.shares.delete(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター

account_id：Uuid —

share_id：Uuid —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.shares.update(...) -> AsyncHttpResponse[ShareResponse]

共有を更新します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 import datetime
2 
3 from frameio import Frameio
4 from frameio.shares import UpdateShareParamsData
5 
6 client = Frameio(
7     token="YOUR_TOKEN",
8 )
9 client.shares.update(
10     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
11     share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
12     data=UpdateShareParamsData(
13         access="public",
14         description="A descriptive summary of the share",
15         downloading_enabled=True,
16         expiration=datetime.datetime.fromisoformat(
17             "2026-01-22 17:04:53+00:00",
18         ),
19         name="Share Name",
20         passphrase="as!dfj39sd(*",
21     ),
22 )

パラメーター

account_id：Uuid —

share_id：Uuid—

data：UpdateShareParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.shares.list_reviewers(...) -> AsyncPager[User, ShareReviewersResponse]

共有レビュアーをリストします。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 response = client.shares.list_reviewers(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     after="<opaque_cursor>",
10     page_size=10,
11     include_total_count=False,
12 )
13 for item in response:
14     yield item
15 # alternatively, you can paginate page-by-page
16 for page in response.iter_pages():
17     yield page

パラメーター

account_id：Uuid —

share_id：Uuid—

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.shares.add_reviewers(...) -> AsyncHttpResponse[None]

次の 3 つの識別子タイプにより、レビュアーを安全な共有に追加します：adobe_user_id, email, and user_id リクエストには、識別子タイプパラメーターを 1 つのみ含めることができます。 email は、共有が属しているアカウントで Frame アカウントメンバーを持たないレビュアーを共有に追加できる唯一の識別子です。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.shares import (
3     AddReviewersToShareParamsData,
4     AddReviewersToShareParamsDataReviewers,
5 )
6 
7 client = Frameio(
8     token="YOUR_TOKEN",
9 )
10 client.shares.add_reviewers(
11     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
12     share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
13     data=AddReviewersToShareParamsData(
14         message="Please join my share!",
15         reviewers=AddReviewersToShareParamsDataReviewers(
16             emails=["email1@domain.com", "email2@domain.com"],
17         ),
18     ),
19 )

パラメーター

account_id：Uuid —

share_id：Uuid—

data：AddReviewersToShareParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.shares.remove_reviewers(...) -> AsyncHttpResponse[None]

次の 3 つの識別子タイプにより、安全な共有からレビュアーを削除します：adobe_user_id, email, and user_id リクエストには、識別子タイプパラメーターを 1 つのみ含めることができます。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.shares import (
3     RemoveReviewerParamsData,
4     RemoveReviewerParamsDataReviewers,
5 )
6 
7 client = Frameio(
8     token="YOUR_TOKEN",
9 )
10 client.shares.remove_reviewers(
11     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
12     share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
13     data=RemoveReviewerParamsData(
14         reviewers=RemoveReviewerParamsDataReviewers(
15             adobe_user_ids=[
16                 "2A3C1A3D66C621B20A494021@176719f5667c82b4499999.e"
17             ],
18         ),
19     ),
20 )

パラメーター

account_id：Uuid —

share_id：Uuid—

data：RemoveReviewerParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.shares.remove_asset(...) -> AsyncHttpResponse[RemoveAssetResponse]

共有から現在、その共有にあるアセットを削除します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.shares.remove_asset(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     asset_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10 )

パラメーター

account_id：Uuid —

share_id：Uuid—

asset_id：Uuid—

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.shares.add_asset(...) -> AsyncHttpResponse[AddAssetResponse]

新しいアセット共有を追加します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 from frameio import Frameio
2 from frameio.shares import AddAssetParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.shares.add_asset(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=AddAssetParamsData(
11         asset_id="0cc1cb59-1d7c-4176-8532-afe099897318",
12     ),
13 )

パラメーター

account_id：Uuid —

share_id：Uuid—

data：AddAssetParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.shares.index(...) -> AsyncPager[Share, SharesResponse]

プロジェクト上の共有をリストします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 response = client.shares.index(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     after="<opaque_cursor>",
10     page_size=10,
11     include_total_count=False,
12 )
13 for item in response:
14     yield item
15 # alternatively, you can paginate page-by-page
16 for page in response.iter_pages():
17     yield page

パラメーター

account_id：Uuid —

project_id：Uuid—

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.shares.create(...) -> AsyncHttpResponse[ShareResponse]

共有を作成します。レート制限：account_user あたり 1.00 分ごとに 10 呼び出し

usage

1 import datetime
2 
3 from frameio import Frameio
4 from frameio.shares import CreateShareParamsData_Asset
5 
6 client = Frameio(
7     token="YOUR_TOKEN",
8 )
9 client.shares.create(
10     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
11     project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
12     data=CreateShareParamsData_Asset(
13         access="public",
14         asset_ids=[
15             "12eb1446-5736-4f93-85fc-3b636f156211",
16             "f23a3b3e-7b1f-4655-b91a-acf0566e5bb9",
17         ],
18         downloading_enabled=True,
19         expiration=datetime.datetime.fromisoformat(
20             "2026-01-22 17:04:53+00:00",
21         ),
22         name="Share Name",
23         passphrase="as!dfj39sd(*",
24     ),
25 )

パラメーター

account_id：Uuid —

project_id：Uuid—

data：CreateShareParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

ファイル

client.files.list(...) -> AsyncHttpResponse[AssetsWithIncludesResponse]

指定されたフォルダー内のファイルをリストします。レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.files.list(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     include="media_links",
10     after="<opaque_cursor>",
11     page_size=10,
12     include_total_count=False,
13 )

パラメーター

account_id：Uuid —

folder_id：Uuid —

include：typing.Optional[FileWithMediaLinksInclude] —

after：typing.Optional[RequestAfterOpaqueCursor]

ページネーションされた結果を返すリクエストの不透明カーソルクエリパラメーター。

この値は自動生成され、以前のレスポンスからのリンクの一部として含まれます。人間が読んでわかるようには意図されていません。

page_size：typing.Optional[RequestPageSize] —

include_total_count：typing.Optional[IncludeTotalCount] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.files.create(...) -> AsyncHttpResponse[FileWithUploadUrlsResponse]

親フォルダーの下に新しいファイルを作成します。Create file (local upload) および Create file (remote upload) は、このエンドポイントを置換しています。レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 from frameio import Frameio
2 from frameio.files import FileCreateParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.files.create(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=FileCreateParamsData(
11         file_size=1137444,
12         media_type="image/png",
13         name="asset.png",
14     ),
15 )

パラメーター

account_id：Uuid —

folder_id：Uuid —

data：FileCreateParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.files.show(...) -> AsyncHttpResponse[FileWithIncludesResponse]

ファイルの詳細を表示します。 include クエリパラメーターを使用して、レスポンスに追加のプロパティを選択的に含めます。

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

レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.files.show(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     include="media_links",
10 )

パラメーター

account_id：Uuid —

file_id：Uuid —

include：typing.Optional[FileWithMediaLinksInclude] —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.files.delete(...) -> AsyncHttpResponse[None]

ID でファイルを削除します。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.files.delete(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター

account_id：Uuid —

file_id：Uuid —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.files.update(...) -> AsyncHttpResponse[FileResponse]

ファイルの詳細を更新します。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 from frameio.files import FileUpdateParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.files.update(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=FileUpdateParamsData(
11         name="asset.png",
12     ),
13 )

パラメーター

account_id：Uuid —

file_id：Uuid —

data：FileUpdateParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.files.copy(...) -> AsyncHttpResponse[FileCopyResponse]

ファイルをコピーします。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 from frameio.files import FileCopyParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.files.copy(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     copy_metadata=True,
11     copy_comments="none",
12     data=FileCopyParamsData(
13         parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
14     ),
15 )

パラメーター

account_id：Uuid —

file_id：Uuid —

copy_metadata：typing.Optional[bool] — ファイルとともにメタデータ値をコピーするかどうか

copy_comments：typing.Optional[FilesCopyRequestCopyComments] — ファイルとともにコピーするコメント

data：typing.Optional[FileCopyParamsData]

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.files.create_remote_upload(...) -> AsyncHttpResponse[FileRemoteUploadResponse]

リモートアップロードを通じて、親フォルダーの下に新しいファイルを作成します。レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 from frameio import Frameio
2 from frameio.files import FileCreateRemoteUploadParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.files.create_remote_upload(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=FileCreateRemoteUploadParamsData(
11         name="asset.png",
12         source_url="https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png",
13     ),
14 )

パラメーター* account_id：Uuid —

folder_id：Uuid —

data：FileCreateRemoteUploadParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.files.move(...) -> AsyncHttpResponse[FileResponse]

ファイルをフォルダーまたは version_stack に移動します。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 from frameio.files import FileMoveParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.files.move(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=FileMoveParamsData(
11         parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
12     ),
13 )

パラメーター account_id：Uuid —

file_id：Uuid —

data：FileMoveParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.files.create_local_upload(...) -> AsyncHttpResponse[FileWithUploadUrlsResponse]

ローカルアップロードを通じて、親フォルダーの下に新しいファイルを作成します。レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 from frameio import Frameio
2 from frameio.files import FileCreateLocalUploadParamsData
3 
4 client = Frameio(
5     token="YOUR_TOKEN",
6 )
7 client.files.create_local_upload(
8     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9     folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
10     data=FileCreateLocalUploadParamsData(
11         file_size=1137444,
12         name="asset.png",
13     ),
14 )

パラメーター account_id：Uuid —

file_id：Uuid —

data：FileCreateLocalUploadParamsData

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

client.files.create_local_upload(...)-> AsyncHttpResponse[FileWithUploadUrlsResponse]

ファイルアップロードステータスの詳細を表示します。レート制限：account_user あたり 1 秒ごとに 5 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.files.show_file_upload_status(
7     account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
8     file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
9 )

パラメーター account_id：Uuid —

file_id：Uuid —

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

ユーザー

client.users.show() -> AsyncHttpResponse[ProfileResponse]

ベアラートークンに関連付けられているユーザーの詳細を確認します。レート制限：account_user あたり 1.00 分ごとに 100 呼び出し

usage

1 from frameio import Frameio
2 
3 client = Frameio(
4     token="YOUR_TOKEN",
5 )
6 client.users.show()

パラメーター

request_options：typing.Optional[RequestOptions] — リクエスト固有の設定。

PyPI

PyPI での表示