アカウントを検索 | Frame.io API Documentation

from frameio_experimental import FrameioExperimental
from frameio_experimental.search import SearchParamsFilters, SearchParamsScope
client = FrameioExperimental(
    token="YOUR_TOKEN_HERE",
)
client.search.search(
    account_id="371a7ae8-f7b5-47f9-a7fc-c7d794b4c668",
    engine="nlp",
    filters=SearchParamsFilters(
        files_and_version_stacks=True,
        folders=False,
        projects=False,
    ),
    query="red car driving on highway",
    scope=SearchParamsScope(
        folder_id="a2d65b16-602d-403a-bf40-bcecf5e26136",
    ),
)

{
  "data": [
    {
      "matches": [
        {
          "name": "red_car.png",
          "terms": [
            "red",
            "car"
          ],
          "type": "name_match"
        }
      ],
      "result": {
        "adobe_id": "urn:aaid:sc:US:a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "created_at": "2023-09-25T19:18:29.614189Z",
        "id": "21c0112f-ecc6-44fd-99cc-a751d6c77737",
        "name": "asset.png",
        "parent_id": "ebf07fcc-979f-4df1-91ca-20a8b5f1d4dc",
        "project_id": "df1bf4b5-57c7-4993-8ad4-96f86a7cfc6f",
        "type": "file",
        "updated_at": "2024-02-07T16:44:41.986478Z",
        "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c"
      },
      "type": "file_result"
    }
  ],
  "links": {
    "next": "/v4/accounts/1234/search?after=abc123"
  },
  "total_count": 15
}

Search across assets, folders, and projects within an account.
Rate Limits: 100 calls per 1.00 minute(s) per account_user

認証

AuthorizationBearer

Bearer <token>形式のBearer認証。tokenは認証トークンです。

パスパラメータ

account_idstring必須

A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be prefixed with adobe: (e.g. adobe:<adobe_org_id> for an account, adobe:<adobe_asset_id> for a project or folder, adobe:adobe:<adobe_asset_id>|<version>` for a file asset).

A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be prefixed with `adobe:` (e.g. `adobe:<adobe_org_id>` for an account, `adobe:<adobe_asset_id>` for a project or folder, `adobe:`adobe:<adobe_asset_id>|<version>` for a file asset).

クエリパラメータ

afterstringオプション

Opaque Cursor query param for requests returning paginated results.

NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.

page_sizeintegerオプション1-100デフォルト値 50

Page size query param for requests

include_total_countbooleanオプションデフォルト値 false

Page query param to include the count of all entities

リクエスト

Search parameters

engineenum必須

Search engine to use. Available engines: lexical, nlp.

querystring必須1-1000 characters

The search query text

filtersobjectオプション

Filters to control which types of results are returned

scopeobjectオプション

Restrict search results to a location within the account: a workspace, a project, a folder, or any combination of workspace_id, project_id, and folder_id.

レスポンスヘッダー

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

レスポンス

datalist of objects

List of search results

linksobject

Links to paginated data

total_countinteger or nullオプション

Total number of matching results

エラー

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error