1
Submit
Submit the search with
create_bucket_search_request. Only search_term is required; everything else narrows the result set. The response returns the request id you poll on.2
Poll
Poll
get_bucket_search_request with the id from the submit step. Check status until the search is finished. has_more_result_than_limit tells you whether the result set was capped.3
Read
Read the matched files with
list_bucket_search_result. Pass the request id as searchrequest. Page with page/page_size, and narrow with file_category, size_range, or a free-text search over the bucket hostname and link.Request parameters
Submit parameters (create_bucket_search_request):
Read parameters (
list_bucket_search_result):
Credits and rate limits: all three endpoints cost 0 credits. Submit is throttled to 100 requests/day; poll and read are each throttled to 500 requests/day.
What comes back
The poll response (get_bucket_search_request) describes the request itself — id, search_term, status, create_date, update_date, created_at, and has_more_result_than_limit.
The read response (list_bucket_search_result) is a paginated envelope:
count— number of results in this page.total_count— total matches across all pages.next/previous— page cursors,nullat the ends.available_categories— file categories present in this result set, so you know whichfile_categoryfilters will return data.results— the matched files.
results carries:
id— result identifier.link— direct URL to the exposed file.bucket— the bucket hostname or ID holding the file.size— file size in bytes.file_extension— the file’s extension.last_modified— when the file was last changed in the bucket.appeared_date— when the file was first observed.found_sensitive— flag for sensitive content detected in the file.searchrequest— the originating requestid.
link, confirm whether each file is still publicly reachable, and route any found_sensitive hits to the bucket owner for takedown. If has_more_result_than_limit is true, tighten extensions, size_range, or the date window and re-run to surface the rest.