Search account | Frame.io API Documentation

from frameio import Frameio
from frameio.search import SearchParamsFilters
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.search.search(
    account_id="25581f19-7fd6-4905-9892-802373e09ee9",
    engine="nlp",
    query="red car driving on highway",
    filters=SearchParamsFilters(
        files_and_version_stacks=True,
        folders=False,
        projects=False,
    ),
)

{
  "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": "b3bbca67-8df1-4fd4-8869-5a1192831d55",
        "name": "asset.png",
        "parent_id": "082cae25-f199-4f09-852a-d201ff9240c7",
        "project_id": "1ba23162-1f0f-4ea6-9cf0-15fe47d759d0",
        "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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequiredformat: "uuid"

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

Query parameters

afterstringOptional

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_sizeintegerOptional1-100Defaults to 50

Page size query param for requests

include_total_countbooleanOptionalDefaults to false

Page query param to include the count of all entities

Request

Search parameters

engineenumRequired

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

Allowed values:

querystringRequired1-1000 characters

The search query text

filtersobjectOptional

Filters to control which types of results are returned

Response headers

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

Response

datalist of objects

List of search results

linksobject

Links to paginated data

total_countinteger or null

Total number of matching results

Errors

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