搜索帐户 | Frame.io API Documentation

from frameio import Frameio
from frameio.search import SearchParamsFilters
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.search.search(
    account_id="f36e5ece-5a27-4e29-b9ba-2b806cb1fe5b",
    engine="nlp",
    filters=SearchParamsFilters(
        files_and_version_stacks=True,
        folders=False,
        projects=False,
    ),
    query="red car driving on highway",
)

{
  "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 身份验证，格式为 Bearer <token>，其中 token 是您的身份验证令牌。

路径参数

account_idstring必需格式: "uuid"

A UUID string that uniquely identifies a Frame.io entity.

查询参数

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

响应头

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