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

インストール

pip install frameio

使用法

以下でクライアントをインスタンス化して使用します：

from frameio import (
    Frameio,
    SelectDefinitionParamsFieldConfiguration,
    SelectDefinitionParamsFieldConfigurationOptionsItem,
)
from frameio.metadata_fields import CreateFieldDefinitionParamsData_Select
client = Frameio(
    token="YOUR_TOKEN",
)
client.metadata_fields.metadata_field_definitions_create(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=CreateFieldDefinitionParamsData_Select(
        field_configuration=SelectDefinitionParamsFieldConfiguration(
            enable_add_new=False,
            options=[
                SelectDefinitionParamsFieldConfigurationOptionsItem(
                    display_name="Option 1",
                ),
                SelectDefinitionParamsFieldConfigurationOptionsItem(
                    display_name="Option 2",
                ),
            ],
        ),
        name="Fields definition name",
    ),
)

非同期クライアント

SDK は非同期クライアントも書き出しするため、API への非ブロッキング呼び出しを行うことができます。非同期 httpx クライアントクラスを構築してこのクライアントに渡す場合は、httpx.Client() の代わりに httpx.AsyncClient() を使用してください（例：このクライアントの httpx_client パラメーター）。

import asyncio
from frameio import (
    AsyncFrameio,
    SelectDefinitionParamsFieldConfiguration,
    SelectDefinitionParamsFieldConfigurationOptionsItem,
)
from frameio.metadata_fields import CreateFieldDefinitionParamsData_Select
client = AsyncFrameio(
    token="YOUR_TOKEN",
)
async def main() -> None:
    await client.metadata_fields.metadata_field_definitions_create(
        account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
        data=CreateFieldDefinitionParamsData_Select(
            field_configuration=SelectDefinitionParamsFieldConfiguration(
                enable_add_new=False,
                options=[
                    SelectDefinitionParamsFieldConfigurationOptionsItem(
                        display_name="Option 1",
                    ),
                    SelectDefinitionParamsFieldConfigurationOptionsItem(
                        display_name="Option 2",
                    ),
                ],
            ),
            name="Fields definition name",
        ),
    )
asyncio.run(main())

例外処理

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

from frameio.core.api_error import ApiError
try:
    client.metadata_fields.metadata_field_definitions_create(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

ページネーション

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

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
response = client.project_permissions.index(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    page_size=10,
    include_total_count=False,
)
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

上級

生の応答データへのアクセス

SDK は .with_raw_response プロパティを通じて、ヘッダーを含む生の応答データへのアクセスを提供します。.with_raw_response プロパティは、.headers および .data 属性へのアクセスに使用できる「生の」クライアントを返します。

from frameio import Frameio
client = Frameio(
    ...,
)
response = (
    client.metadata_fields.with_raw_response.metadata_field_definitions_create(
        ...
    )
)
print(response.headers)  # access the response headers
print(response.data)  # access the underlying object
pager = client.project_permissions.index(...)
print(pager.response.headers)  # access the response headers for the first page
for item in pager:
    print(item)  # access the underlying object(s)
for page in pager.iter_pages():
    print(page.response.headers)  # access the response headers for each page
    for item in page:
        print(item)  # access the underlying object(s)

再試行

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

以下の HTTP ステータスコードのいずれかが返された場合、リクエストは再試行可能と見なされます：

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

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

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

タイムアウト

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

from frameio import Frameio
client = Frameio(
    ...,
    timeout=20.0,
)
# Override timeout for a specific method
client.metadata_fields.metadata_field_definitions_create(..., request_options={
    "timeout_in_seconds": 1
})

カスタムクライアント

ユースケースに合わせてカスタマイズするために httpx クライアントを上書きできます。一般的なユースケースには、プロキシおよびトランスポートのサポートが含まれます。

import httpx
from frameio import Frameio
client = Frameio(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

リファレンス

認証

frameio.auth.ServerToServerAuth(*, client_id, client_secret, ...)

OAuth 2.0 client_credentials付与を使用して認証します。この流量にはユーザーは関与せず、リフレッシュトークンは返されません。アクセストークンが期限切れになると、SDKはクライアント資格情報を使用して自動的に新しいトークンをリクエストします。非同期使用の場合は、AsyncServerToServerAuthを使用してください。

usage

from frameio import Frameio
from frameio.auth import ServerToServerAuth
auth = ServerToServerAuth(client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET")
client = Frameio(token=auth.get_token)

パラメーター

client_id: str — Adobe IMS OAuthクライアントID。

client_secret: str — Adobe IMS OAuthクライアントシークレット。

scopes: str — スペース区切りの範囲（OAuth 2.0 RFC 6749）。デフォルトはopenid AdobeID frame.s2s.allです。

ims_base_url: str — ステージング/代替環境用のIMSベースURL。デフォルトは本番環境です。

http_client: typing.Optional[httpx.Client] — プロキシ、TLS、またはコネクションプーリング用のオプションのhttpx。プロキシ、TLS、またはコネクションプーリング用のクライアント。

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — すべてのトークンフェッチ後に実行されるオプションのコールバック。

timeout: float — HTTPリクエストタイムアウト（秒）。デフォルトは30です。

max_retries: int — 一時的な障害に対する最大リトライ回数。デフォルトは2です。

refresh_buffer: int — 期限切れ前の秒数で、プロアクティブなリフレッシュをトリガーします。デフォルトは60です。メソッド get_token() -> str — 必要に応じてリフレッシュし、有効なアクセストークンを返します。このメソッドの参照（呼び出しではない）をSDKに渡してください：Frameio(token=auth.get_token)。authenticate() -> dict[str, Any] — 明示的に新しいアクセストークンを取得します。アクセストークン access_token、有効期限 expires_in などを含むトークンレスポンス辞書を返します。revoke() -> None — サーバーサイドで両方のトークンを無効化し、ローカル状態をクリアします。export_tokens() -> dict[str, Any] — 永続化のために現在のトークン状態をエクスポートします。import_tokens(data: dict[str, Any]) -> None — 以前にエクスポートされた辞書からトークン状態を復元します。

frameio.auth.WebAppAuth(*, client_id, client_secret, redirect_uri, ...)

OAuth 2.0 authorization_code 付与を使用して認証します。クライアントシークレットを安全に保存できるサーバーサイドアプリケーションで使用してください。非同期使用の場合は、AsyncWebAppAuth を使用してください。

usage

import secrets
from frameio import Frameio
from frameio.auth import WebAppAuth
auth = WebAppAuth(
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
    redirect_uri="https://myapp.com/callback",
)
url = auth.get_authorization_url(state=secrets.token_urlsafe(32))
# redirect user to url ...
auth.exchange_code(code="CODE_FROM_CALLBACK")
client = Frameio(token=auth.get_token)

パラメーター

client_id: str — Adobe IMS OAuth クライアント ID。

client_secret: str — Adobe IMS OAuth クライアントシークレット。

redirect_uri: str — 登録されたリダイレクト URI。

scopes: str — スペース区切りの範囲（OAuth 2.0 RFC 6749）。

ims_base_url: str — ステージング/代替環境用の IMS ベース URL。デフォルトは本番環境です。

http_client: typing.Optional[httpx.Client] — プロキシ、TLS、または接続プーリング用のオプションの httpx。プロキシ、TLS、または接続プーリング用のクライアント。

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — トークン更新後に毎回実行されるオプションのコールバック。

timeout: float — HTTP リクエストタイムアウト（秒）。デフォルトは 30 です。

max_retries: int — 一時的な障害の最大再試行回数。デフォルトは 2 です。

refresh_buffer: int — 有効期限前にプロアクティブ更新をトリガーする秒数。デフォルトは 60 です。メソッド get_token() -> str — 必要に応じて更新して、有効なアクセストークンを返します。このメソッド参照を SDK に渡してください：Frameio(token=auth.get_token)。get_authorization_url(state: str) -> str — Adobe IMS 認証 URL を作成します。不透明な CSRF/state 値を渡します。この値はエコーバックされます。exchange_code(code: str) -> dict[str, Any] — 認証コードをアクセストークンとリフレッシュトークンに交換します。refresh() -> dict[str, Any] — トークンの更新を手動でトリガーします。revoke() -> None — 両方のトークンをサーバーサイドで取り消し、ローカル状態をクリアします。export_tokens() -> dict[str, Any] — 永続化のために現在のトークン状態を書き出します。import_tokens(data: dict[str, Any]) -> None — 以前に書き出した辞書からトークン状態を復元します。

frameio.auth.SPAAuth(*, client_id, redirect_uri, ...)

authorization_code + PKCE を使用して認証します（クライアントシークレットは不要）。クライアントシークレットを安全に保存できないブラウザーベースまたはネイティブアプリケーションでこれを使用します。非同期使用の場合は、AsyncSPAAuth を使用します。

usage

import secrets
from frameio import Frameio
from frameio.auth import SPAAuth
auth = SPAAuth(client_id="YOUR_CLIENT_ID", redirect_uri="https://myapp.com/cb")
result = auth.get_authorization_url(state=secrets.token_urlsafe(32))
# redirect user to result.url, store result.code_verifier
auth.exchange_code(code="CODE_FROM_CALLBACK", code_verifier=result.code_verifier)
client = Frameio(token=auth.get_token)

パラメーター

client_id: str — Adobe IMS OAuth クライアント ID。

redirect_uri: str — 登録されたリダイレクト URI。

scopes: str — スペース区切りの範囲（OAuth 2.0 RFC 6749）。

ims_base_url: str — ステージング/代替環境用の IMS ベース URL。デフォルトは本番環境です。

on_token_refreshed: typing.Optional[typing.Callable[[dict[str, Any]], None]] — 全てのトークン更新後に呼び出されるオプションのコールバック。

timeout: float — HTTP リクエストのタイムアウト（秒単位）。デフォルトは 30 です。

max_retries: int — 一時的な障害の最大再試行回数。デフォルトは 2 です。

refresh_buffer: int — 有効期限前に事前更新をトリガーする秒数。デフォルトは 60 です。メソッド get_token() -> str — 有効なアクセストークンを返します。必要に応じて更新します。このメソッド参照を SDK に渡します：Frameio(token=auth.get_token)。get_authorization_url(state: str) -> AuthorizationUrlResult — PKCE チャレンジを使用してアドビ IMS 認証 URL を作成します。url と code_verifier 属性を持つ AuthorizationUrlResult を返します。exchange_code(code: str, code_verifier: str) -> dict[str, Any] — 認証コード + PKCE 検証子をトークンに交換します。refresh() -> dict[str, Any] — トークンの更新を手動でトリガーします。revoke() -> None — サーバーサイドで両方のトークンを解除し、ローカル状態をクリアします。export_tokens() -> dict[str, Any] — 永続化のために現在のトークン状態をエクスポートします。import_tokens(data: dict[str, Any]) -> None — 以前にエクスポートした辞書からトークン状態を復元します。

frameio.auth.AuthorizationUrlResult

SPAAuth.get_authorization_url() と AsyncSPAAuth.get_authorization_url() によって返される凍結データクラス。認証 URL と PKCE コード検証子を保持します。Attributes url: str — ユーザーをリダイレクトする完全な認証 URL。code_verifier: str — 保存して exchange_code() に渡す PKCE コード検証子。

frameio.auth.close_clients() / aclose_clients()

認証モジュールで使用されるモジュールレベルの HTTP クライアントを閉じます。接続を解放するために、アプリケーションのシャットダウン時に同期コードでは close_clients() を呼び出し、非同期コードでは await aclose_clients() を呼び出します。

usage

from frameio.auth import close_clients
# During application shutdown
close_clients()

認証例外

すべての認証例外は FrameioAuthError を継承します。

例外	説明
`FrameioAuthError`	すべての `frameio.auth` エラーのベース例外。
`AuthenticationError`	トークンの交換または更新が失敗しました。`error_code` と `error_description` 属性を持ちます。
`TokenExpiredError`	リフレッシュトークンが期限切れです。再認証が必要です。
`ConfigurationError`	必要な設定が不足しているか無効です。
`NetworkError`	ネットワークリクエストが失敗しました（タイムアウト、接続エラーなど）。
`RateLimitError`	APIが429を返し、再試行が完了しました。`retry_after`属性があります。
`PKCEError`	PKCE検証が失敗しました。

メタデータ

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

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

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

usage

from frameio import Frameio
from frameio.metadata import (
    BulkUpdateMetadataParamsData,
    BulkUpdateMetadataParamsDataValuesItem,
)
client = Frameio(
    token="YOUR_TOKEN",
)
client.metadata.bulk_update(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=BulkUpdateMetadataParamsData(
        file_ids=[
            "09b31c2a-04de-464a-a593-643a36ef0d98",
            "b967fc36-4e18-4b48-a3ab-c790100e2baa",
        ],
        values=[
            BulkUpdateMetadataParamsDataValuesItem(
                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

account_id: Uuid —

project_id: Uuid —

data: BulkUpdateMetadataParamsData

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

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

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.metadata.show(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    show_null=True,
)

Parameters

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]

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.metadata_fields.metadata_field_definitions_delete(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    field_definition_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

Parameters

account_id: Uuid —

field_definition_id: Uuid —

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

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

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

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

usage

from frameio import (
    Frameio,
    UpdateSelectDefinitionParamsFieldConfiguration,
    UpdateSelectDefinitionParamsFieldConfigurationOptionsItem,
)
from frameio.metadata_fields import UpdateFieldDefinitionParamsData_Select
client = Frameio(
    token="YOUR_TOKEN",
)
client.metadata_fields.metadata_field_definitions_update(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    field_definition_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=UpdateFieldDefinitionParamsData_Select(
        field_configuration=UpdateSelectDefinitionParamsFieldConfiguration(
            enable_add_new=False,
            options=[
                UpdateSelectDefinitionParamsFieldConfigurationOptionsItem(
                    display_name="Option 1",
                ),
                UpdateSelectDefinitionParamsFieldConfigurationOptionsItem(
                    display_name="Option 2",
                ),
            ],
        ),
        name="Updated-Field-Name",
    ),
)

パラメーター

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

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

パラメーター

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

from frameio import (
    Frameio,
    SelectDefinitionParamsFieldConfiguration,
    SelectDefinitionParamsFieldConfigurationOptionsItem,
)
from frameio.metadata_fields import CreateFieldDefinitionParamsData_Select
client = Frameio(
    token="YOUR_TOKEN",
)
client.metadata_fields.metadata_field_definitions_create(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=CreateFieldDefinitionParamsData_Select(
        field_configuration=SelectDefinitionParamsFieldConfiguration(
            enable_add_new=False,
            options=[
                SelectDefinitionParamsFieldConfigurationOptionsItem(
                    display_name="Option 1",
                ),
                SelectDefinitionParamsFieldConfigurationOptionsItem(
                    display_name="Option 2",
                ),
            ],
        ),
        name="Fields definition name",
    ),
)

パラメーター

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

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
response = client.project_permissions.index(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include_deactivated=True,
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    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

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.project_permissions.delete(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    user_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

Parameters

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

from frameio import Frameio, UpdateUserRolesParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.project_permissions.project_user_roles_update(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    user_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=UpdateUserRolesParamsData(
        role="editor",
    ),
)

Parameters

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

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.projects.show(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

Parameters

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

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.projects.delete(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

Parameters

account_id: Uuid —

project_id: Uuid —

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

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

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

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

usage

from frameio import Frameio
from frameio.projects import ProjectUpdateParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.projects.update(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=ProjectUpdateParamsData(
        name="Project Name",
        restricted=True,
        status="active",
    ),
)

Parameters

account_id: Uuid —

project_id: Uuid —

data: ProjectUpdateParamsData

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

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

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
response = client.projects.index(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

Parameters

account_id: Uuid —

workspace_id: Uuid —

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

after: typing.Optional[RequestAfterOpaqueCursor]

ページネーション結果を返すリクエストのOpaque Cursorクエリパラメータ。

この値は自動生成され、前回の応答からのリンクの一部として含まれます。人間が読めるように意図されていません。

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

from frameio import Frameio
from frameio.projects import ProjectParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.projects.create(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=ProjectParamsData(
        name="Project Name",
        restricted=True,
    ),
)

パラメータ

account_id：Uuid —

workspace_id：Uuid —

data：ProjectParamsData

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

フォルダー

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

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.folders.show(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include="creator",
)

パラメータ

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

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.folders.delete(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

パラメータ

account_id：Uuid —

folder_id：Uuid —

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

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

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

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

usage

from frameio import Frameio
from frameio.folders import FolderUpdateParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.folders.update(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=FolderUpdateParamsData(
        name="Folder name",
    ),
)

パラメータ

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

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.folders.index(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include="media_links",
    type="file,folder,version_stack",
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)

パラメーター

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

from frameio import Frameio
from frameio.folders import FolderCopyParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.folders.copy(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    copy_metadata=True,
    data=FolderCopyParamsData(
        parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
    ),
)

パラメーター

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

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.folders.list(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include="creator",
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)

パラメーター

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

from frameio import Frameio
from frameio.folders import FolderCreateParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.folders.create(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=FolderCreateParamsData(
        name="Folder name",
    ),
)

パラメーター

account_id: Uuid —

folder_id: Uuid —

data: FolderCreateParamsData

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

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

フォルダーをフォルダーに移動。

レート制限: account_userあたり1.00分（複数）で10回の呼び出し

usage

from frameio import Frameio
from frameio.folders import FolderMoveParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.folders.move(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=FolderMoveParamsData(
        parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
    ),
)

パラメーター

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メディアリンクを適切に処理する必要があります。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.version_stacks.index(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    version_stack_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include="media_links",
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)

パラメータ

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]

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.version_stacks.show(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    version_stack_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include="media_links",
)

パラメータ

account_id：Uuid —

version_stack_id：Uuid —

include：typing.Optional[VersionStacksShowRequestInclude] —

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

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

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

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

usage

from frameio import Frameio
from frameio.version_stacks import VersionStackCopyParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.version_stacks.copy(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    version_stack_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    copy_metadata=True,
    data=VersionStackCopyParamsData(
        parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
    ),
)

パラメータ

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]

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.version_stacks.list(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include="media_links",
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)

パラメータ

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]

親フォルダーの下に新しいVersionスタックを作成。

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

usage

from frameio import Frameio
from frameio.version_stacks import VersionStackCreateParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.version_stacks.create(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=VersionStackCreateParamsData(
        file_ids=[
            "dd2a3cdd-fc90-41bd-a7b8-8a0447aec6d4",
            "79fed48a-8372-496e-8dcb-5e959b9b9fcf",
        ],
    ),
)

Parameters

account_id: Uuid —

folder_id: Uuid —

data: VersionStackCreateParamsData

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

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

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

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

usage

from frameio import Frameio
from frameio.version_stacks import VersionStackMoveParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.version_stacks.move(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    version_stack_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=VersionStackMoveParamsData(
        parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
    ),
)

Parameters

account_id: Uuid —

version_stack_id: Uuid —

data: VersionStackMoveParamsData

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

アカウント権限

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

指定されたアカウントのユーザーロールを一覧表示。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
response = client.account_permissions.index(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include_deactivated=True,
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

Parameters

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] — リクエスト固有の設定。

Accounts

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

現在のユーザーのアカウントを一覧表示。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
response = client.accounts.index(
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

Parameters

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]

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.comments.show(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    comment_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include="owner",
)

Parameters

account_id: Uuid —

comment_id: Uuid —

include: typing.Optional[CommentsShowRequestInclude] —

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

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

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.comments.delete(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    comment_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

Parameters

account_id: Uuid —

comment_id: Uuid —

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

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

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

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

usage

from frameio import Frameio
from frameio.comments import UpdateCommentParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.comments.update(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    comment_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    timestamp_as_timecode=True,
    data=UpdateCommentParamsData(
        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

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]

指定されたアセット上のコメントを一覧表示します。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
response = client.comments.index(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include="owner",
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

Parameters

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]

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

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

usage

from frameio import Frameio
from frameio.comments import CreateCommentParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.comments.create(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    timestamp_as_timecode=True,
    data=CreateCommentParamsData(
        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

account_id: Uuid —

file_id: Uuid —

data: CreateCommentParamsData

timestamp_as_timecode: typing.Optional[bool] —

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

Webhooks

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

指定されたWorkspace用のWebhookをリスト表示します。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
response = client.webhooks.index(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    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を1つ作成します。

有効なイベント：

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分間に10コール

usage

from frameio import Frameio
from frameio.webhooks import WebhookCreateParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.webhooks.create(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=WebhookCreateParamsData(
        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",
    ),
)

パラメーター

account_id：Uuid —

workspace_id：Uuid —

data：WebhookCreateParamsData

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

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

Webhookの詳細を表示します。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.webhooks.show(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    webhook_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

パラメーター

account_id：Uuid —

webhook_id：Uuid —

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

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

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

Webhookを削除します。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.webhooks.delete(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    webhook_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

パラメーター

account_id：Uuid —

webhook_id：Uuid —

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

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

Webhookの詳細を更新します。

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

usage

from frameio import Frameio
from frameio.webhooks import WebhookUpdateParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.webhooks.update(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    webhook_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=WebhookUpdateParamsData(
        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",
    ),
)

パラメーター

account_id：Uuid —

webhook_id：Uuid —

data：WebhookUpdateParamsData

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

Workspace権限

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

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
response = client.workspace_permissions.index(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include_deactivated=True,
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    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]

指定されたワークスペースからユーザーを削除します。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.workspace_permissions.workspace_user_roles_delete(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    user_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

パラメータ

account_id: Uuid —

workspace_id: Uuid —

user_id: Uuid —

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

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

ユーザーが既にワークスペースに追加されている場合、指定されたワークスペースのユーザー役割を更新します。ユーザーがワークスペースに追加されていない場合、指定された役割でユーザーが追加されます。

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

usage

from frameio import Frameio, UpdateUserRolesParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.workspace_permissions.workspace_user_roles_update(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    user_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=UpdateUserRolesParamsData(
        role="editor",
    ),
)

パラメータ

account_id: Uuid —

workspace_id: Uuid—

user_id: Uuid —

data: UpdateUserRolesParamsData

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

ワークスペース

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

ワークスペースの詳細を表示します。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.workspaces.show(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

パラメータ

account_id: Uuid —

workspace_id: Uuid —

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

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

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

アカウントからワークスペースを削除します。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.workspaces.delete(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

パラメーター

account_id: Uuid —

workspace_id: Uuid —

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

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

Workspaceを更新します。

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

usage

from frameio import Frameio, WorkspaceParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.workspaces.update(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    workspace_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=WorkspaceParamsData(
        name="My Workspace",
    ),
)

パラメーター

account_id: Uuid —

workspace_id: Uuid —

data: WorkspaceParamsData

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

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

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
response = client.workspaces.index(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    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]

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

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

usage

from frameio import Frameio, WorkspaceParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.workspaces.create(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=WorkspaceParamsData(
        name="My Workspace",
    ),
)

パラメーター

account_id: Uuid —

data: WorkspaceParamsData

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

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

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.shares.show(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

パラメーター

account_id: Uuid —

share_id: Uuid —

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

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

共有を削除します。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.shares.delete(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

Parameters

account_id: Uuid —

share_id: Uuid —

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

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

共有を更新。

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

usage

import datetime
from frameio import Frameio
from frameio.shares import UpdateShareParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.shares.update(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=UpdateShareParamsData(
        access="public",
        description="A descriptive summary of the share",
        downloading_enabled=True,
        expiration=datetime.datetime.fromisoformat(
            "2026-01-22 17:04:53+00:00",
        ),
        name="Share Name",
        passphrase="as!dfj39sd(*",
    ),
)

Parameters

account_id: Uuid —

share_id: Uuid—

data: UpdateShareParamsData

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

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

共有レビューアーをリスト表示。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
response = client.shares.list_reviewers(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

Parameters

account_id: Uuid —

share_id: Uuid—

after: typing.Optional[RequestAfterOpaqueCursor]

ページ分割された結果を返すリクエストのためのOpaque Cursorクエリパラメータ。

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

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、user_idでセキュア共有にレビューアーを追加。

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

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

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

usage

from frameio import Frameio
from frameio.shares import (
    AddReviewersToShareParamsData,
    AddReviewersToShareParamsDataReviewers,
)
client = Frameio(
    token="YOUR_TOKEN",
)
client.shares.add_reviewers(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=AddReviewersToShareParamsData(
        message="Please join my share!",
        reviewers=AddReviewersToShareParamsDataReviewers(
            emails=["email1@domain.com", "email2@domain.com"],
        ),
    ),
)

Parameters

account_id: Uuid —

share_id: Uuid—

data: AddReviewersToShareParamsData

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

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

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

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

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

usage

from frameio import Frameio
from frameio.shares import (
    RemoveReviewerParamsData,
    RemoveReviewerParamsDataReviewers,
)
client = Frameio(
    token="YOUR_TOKEN",
)
client.shares.remove_reviewers(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=RemoveReviewerParamsData(
        reviewers=RemoveReviewerParamsDataReviewers(
            adobe_user_ids=[
                "2A3C1A3D66C621B20A494021@176719f5667c82b4499999.e"
            ],
        ),
    ),
)

Parameters

account_id: Uuid —

share_id: Uuid—

data: RemoveReviewerParamsData

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

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

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.shares.remove_asset(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    asset_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

パラメーター

account_id: Uuid —

share_id: Uuid—

asset_id: Uuid—

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

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

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

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

usage

from frameio import Frameio
from frameio.shares import AddAssetParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.shares.add_asset(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    share_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=AddAssetParamsData(
        asset_id="0cc1cb59-1d7c-4176-8532-afe099897318",
    ),
)

パラメーター

account_id: Uuid —

share_id: Uuid—

data: AddAssetParamsData

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

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

プロジェクトの共有をリスト表示。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
response = client.shares.index(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    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分間に10回の呼び出し

usage

import datetime
from frameio import Frameio
from frameio.shares import CreateShareParamsData_Asset
client = Frameio(
    token="YOUR_TOKEN",
)
client.shares.create(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    project_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=CreateShareParamsData_Asset(
        access="public",
        asset_ids=[
            "12eb1446-5736-4f93-85fc-3b636f156211",
            "f23a3b3e-7b1f-4655-b91a-acf0566e5bb9",
        ],
        downloading_enabled=True,
        expiration=datetime.datetime.fromisoformat(
            "2026-01-22 17:04:53+00:00",
        ),
        name="Share Name",
        passphrase="as!dfj39sd(*",
    ),
)

パラメーター

account_id: Uuid —

project_id: Uuid—

data: CreateShareParamsData

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

ファイル

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

指定されたフォルダー内のファイルをリスト表示。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.files.list(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include="media_links",
    after="<opaque_cursor>",
    page_size=10,
    include_total_count=False,
)

パラメーター

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]

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

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

usage

from frameio import Frameio
from frameio.files import FileCreateParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.files.create(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=FileCreateParamsData(
        file_size=1137444,
        media_type="image/png",
        name="asset.png",
    ),
)

パラメーター

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メディアリンクを適切に処理する必要があります。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.files.show(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    include="media_links",
)

パラメーター

account_id: Uuid —

file_id: Uuid —

include: typing.Optional[FileWithMediaLinksInclude] —

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

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

IDでファイルを削除。

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.files.delete(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

パラメーター

account_id: Uuid —

file_id: Uuid —

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

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

ファイル詳細を更新。

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

usage

from frameio import Frameio
from frameio.files import FileUpdateParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.files.update(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=FileUpdateParamsData(
        name="asset.png",
    ),
)

パラメーター

account_id: Uuid —

file_id: Uuid —

data: FileUpdateParamsData

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

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

ファイルをコピー。

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

usage

from frameio import Frameio
from frameio.files import FileCopyParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.files.copy(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    copy_metadata=True,
    copy_comments="none",
    data=FileCopyParamsData(
        parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
    ),
)

パラメーター

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

from frameio import Frameio
from frameio.files import FileCreateRemoteUploadParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.files.create_remote_upload(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=FileCreateRemoteUploadParamsData(
        name="asset.png",
        source_url="https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png",
    ),
)

Parameters

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

from frameio import Frameio
from frameio.files import FileMoveParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.files.move(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=FileMoveParamsData(
        parent_id="2e426fe0-f965-4594-8b2b-b4dff1dc00ec",
    ),
)

Parameters

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

from frameio import Frameio
from frameio.files import FileCreateLocalUploadParamsData
client = Frameio(
    token="YOUR_TOKEN",
)
client.files.create_local_upload(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    folder_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    data=FileCreateLocalUploadParamsData(
        file_size=1137444,
        name="asset.png",
    ),
)

Parameters

account_id: Uuid —

file_id: Uuid —

data: FileCreateLocalUploadParamsData

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

client.files.show_file_upload_status(...) -> AsyncHttpResponse[FileUploadStatusResponse]

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.files.show_file_upload_status(
    account_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
    file_id="b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
)

Parameters

account_id: Uuid —

file_id: Uuid —

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

ユーザー

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

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

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

usage

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN",
)
client.users.show()

Parameters

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

PyPI

PyPIで表示