Konto suchen

POST

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

POST

/v4/accounts/:account_id/search

from frameio import Frameio
from frameio.search import SearchParamsFilters
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.search.search(
    account_id="2b3a497a-4154-4be8-a03b-2bb711ac21fb",
    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",
        "adobe_version_id": "2",
        "created_at": "2023-09-25T19:18:29.614189Z",
        "file_size": 1137444,
        "id": "6ef0cac2-bbed-4339-916f-1ab222c93d00",
        "media_type": "image/png",
        "name": "asset.png",
        "parent_id": "76968ea5-759c-4023-9382-e1e1f248c11b",
        "project_id": "1fad15b4-6c27-498c-b432-eaaa013caee4",
        "status": "created",
        "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

Authentifizierung

AuthorizationBearer

Bearer-Authentifizierung der Form Bearer <token>, wobei token Ihr Auth-Token ist.

Pfadparameter

account_idstringErforderlichFormat: "uuid"

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

Abfrageparameter

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-100Standardwert ist 50

Page size query param for requests

include_total_countbooleanOptionalStandardwert ist false

Page query param to include the count of all entities

Anfrage

Search parameters

engineenumErforderlich

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

querystringErforderlich1-1000 characters

The search query text

filtersobjectOptional

Filters to control which types of results are returned

Antwort-Header

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

Antwort

datalist of objects

List of search results

linksobject

Links to paginated data

total_countinteger or nullOptional

Total number of matching results

Fehler

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