Search#

class frameioclient.Search(client)#

library(query, type=None, project_id=None, account_id=None, team_id=None, uploader=None, sort=None, filter=None, page_size=10, page=1)#

Search for assets using the library search endpoint, documented at https://developer.frame.io/docs/workflows-assets/search-for-assets. For more information check out https://developer.frame.io/api/reference/operation/librarySearchPost/.

# TODO, confirm that account_id is required or not, could we use self.me?

Parameters:

query (str) – The search keyword you want to search with.
account_id (Union[str, UUID]) – The frame.io account want you to contrain your search to (you may only have one, but some users have 20+ that they have acces to).
type (Optional[str]) – The type of frame.io asset you want to search: [file, folder, review_link, presentation].
project_id (Union[str, UUID]) – The frame.io project you want to constrain your search to.
team_id (Union[str, UUID]) – The frame.io team you want to constrain your search to.
uploader (Optional[str]) – The name of the uploader, this includes first + last name with a space.
sort (Optional[str]) – The field you want to sort by.
filter (Optional[str]) – This is only necessary if you want to build a fully custom query, the most common functionality is exposed using other kwargs though.
page_size (Optional[int]) – Useful if you want to increase the number of items returned by the search API here.
page (Optional[int]) – The page of results you’re requesting.

Example:

client.search.library(
    query="Final",
    type="file",
    sort="name"
)