アカウントを検索

POST

https://api.frame.io/v4/accounts/:account_id/search

POST

/v4/accounts/:account_id/search

1 from frameio import Frameio
2 from frameio.search import SearchParamsFilters
3 
4 client = Frameio(
5     token="YOUR_TOKEN_HERE",
6 )
7 
8 client.search.search(
9     account_id="97f16ca3-acb5-431e-aabb-7e435ab97e27",
10     engine="nlp",
11     query="red car driving on highway",
12     filters=SearchParamsFilters(
13         files_and_version_stacks=True,
14         folders=False,
15         projects=False,
16     ),
17 )

1 {
2   "data": [
3     {
4       "matches": [
5         {
6           "name": "red_car.png",
7           "terms": [
8             "red",
9             "car"
10           ],
11           "type": "name_match"
12         }
13       ],
14       "result": {
15         "adobe_id": "urn:aaid:sc:US:a1b2c3d4-e5f6-7890-abcd-ef1234567890",
16         "created_at": "2023-09-25T19:18:29.614189Z",
17         "id": "b684fc75-ea91-4597-be6d-ac30c02e5d00",
18         "name": "asset.png",
19         "parent_id": "0e222c57-3f71-40e5-8675-ced6a4e2a7d4",
20         "project_id": "2f1ef677-07a1-4427-91c5-e0c5389d15cc",
21         "type": "file",
22         "updated_at": "2024-02-07T16:44:41.986478Z",
23         "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c"
24       },
25       "type": "file_result"
26     }
27   ],
28   "links": {
29     "next": "/v4/accounts/1234/search?after=abc123"
30   },
31   "total_count": 15
32 }

アカウント内のアセット、フォルダー、プロジェクトを検索します。レート制限 : account_user あたり 1.00 分ごとに 100 回の呼び出し

認証

AuthorizationBearer

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

パスパラメータ

account_idstring必須形式: "uuid"

Frame.io エンティティを一意に識別する UUID 文字列。

クエリパラメータ

afterstringオプション

ページ分割された結果を返すリクエスト用の不透明なカーソルクエリパラメーター。

注 : この値は自動生成され、前の応答のリンクの一部として含まれます。人が読めることを意図していません。

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

リクエスト用のページサイズクエリパラメーター

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

すべてのエンティティ数を含めるためのページクエリパラメーター

リクエスト

検索パラメーター

engineenum必須

使用する検索エンジン。利用可能なエンジン : lexical、nlp。

querystring必須1-1000 characters

検索クエリのテキスト

filtersobjectオプション

どのタイプの結果を返すかを制御するフィルター

レスポンスヘッダー

x-ratelimit-limitinteger

レート制限

x-ratelimit-remaininginteger

レート制限が残っています

x-ratelimit-windowinteger

レート制限ウィンドウ (ミリ秒)

レスポンス

datalist of objects

検索結果のリスト

linksobject

ページ分割されたデータへのリンク

total_countinteger or nullオプション

一致する結果の合計数

エラー

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