Поиск учетной записи

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="1716f3b3-9288-4a87-b763-c5296f3f676b",
10     engine="nlp",
11     filters=SearchParamsFilters(
12         files_and_version_stacks=True,
13         folders=False,
14         projects=False,
15     ),
16     query="red car driving on highway",
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": "b4c00e24-9beb-4c38-91ad-8f58a88f5a8a",
18         "name": "asset.png",
19         "parent_id": "6ecaf9c3-23ab-4031-8dc8-8acbfec1afbd",
20         "project_id": "70e467b0-c8ab-4881-9c63-836664103a26",
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 }

Поиск по ресурсам, папкам и проектам в учетной записи. Лимиты запросов: 100 вызовов за 1 мин. для account_user

Аутентификация

AuthorizationBearer

Аутентификация Bearer в форме Bearer <token>, где token — ваш токен аутентификации.

Параметры пути

account_idstringОбязательныйformat: "uuid"

Строка UUID, которая однозначно идентифицирует сущность Frame.io.

Параметры запроса

afterstringОпциональный

Параметр запроса “Непрозрачный курсор” для запросов, возвращающих результаты с разбивкой на страницы.

ПРИМЕЧАНИЕ. Это автоматически создаваемое значение, которое включается как часть ссылок из предыдущего ответа. Оно не предназначено для чтения пользователями.

Параметр запроса "Непрозрачный курсор" для запросов, возвращающих результаты с разбивкой на страницы. <br/> ПРИМЕЧАНИЕ. Это автоматически создаваемое значение, которое включается как часть ссылок из предыдущего ответа. Оно не предназначено для чтения пользователями.

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