Sign in
Raw Search

Queue an async mass unlock task for raw search

Creates an asynchronous unlock Task for the given raw search filters. Returns a task_id you can poll with the task-status endpoint.

Request body

  • q: Optional search string (minimum 4 characters if provided). Required if no other filter is provided.
  • container_id: Optional container identifier.
  • exts: Optional list of file extensions to keep.
  • exts_not: Optional list of file extensions to exclude.
  • categories: Optional list of raw file categories.
  • categories_not: Optional list of raw file categories to exclude.
  • file_name: Optional wildcard applied to entry_name.
  • file_name_not: Optional wildcard that must NOT match entry_name.
  • folder_name: Optional match on the folder holding the block (max 20 items, min 4 chars each).
  • folder_name_not: Optional folders to exclude. Not a standalone selector.
  • folder_name_exact: Require folder_name values to be a whole folder at any depth.
  • exclude_terms: Optional content terms to exclude (substring, case-insensitive, max 20, min 4 chars each).
  • ingested_at_min: Optional datetime to filter results ingested on or after.
  • ingested_at_max: Optional datetime to filter results ingested on or before.

Query parameters

  • max: Optional cap of new unlocks. 0 or omitted = use all your points.

Plan requirement Requires a paid plan with raw_search enabled.

Concurrency limit

  • raw: max 1 running and 1 queued task per account.
  • identical active requests return the existing task id.
  • email / domain: max 5 concurrent tasks per user.
  • Returns 429 if limit exceeded.
post/search/raw/unlock/task

Query parameters

maxinteger nullable

0 or omitted = use all your points

0 or omitted = use all your points

dedupboolean

Skip blocks with identical content (same block_fp64) so each unique content is unlocked once. Matches the deduplicated search/export view.

Skip blocks with identical content (same block_fp64) so each unique content is unlocked once. Matches the deduplicated search/export view.

Request body

qstring nullable

Optional full text query to match within raw blocks. Quotes are ignored for the length check. When omitted or empty, you must provide at least one filter among container_id, exts, categories, file_name.

container_idinteger nullable

Restrict the search to a specific container id.

extsstring[] nullable

List of file extensions to include (case-insensitive, without leading dot).

exts_notstring[] nullable

List of file extensions to exclude (case-insensitive, without leading dot).

categoriesstring[] nullable

Filter results by raw file category. Applied after the search query.

categories_notstring[] nullable

Exclude these raw file categories. Applied after the search query.

file_namestring[] nullable

Case-insensitive wildcards that must match the entry name (OR by default, AND if force_and=true).

file_name_notstring[] nullable

Case-insensitive wildcards that must NOT match the entry name.

folder_namestring[] nullable

Case-insensitive match on the folder holding the block (OR by default, AND if force_and=true). By default the value must appear anywhere in the folder path; with folder_name_exact=true it must be a whole folder at any depth. Leading and trailing slashes are ignored.

folder_name_notstring[] nullable

Folders to exclude, same matching rules as folder_name. Not a standalone selector: a search using only folder_name_not is rejected, provide q or another positive filter.

force_andboolean nullable

When true, require all file_name values to match, and all folder_name values to match (AND instead of OR within each list).

file_name_exactboolean nullable

When true, file_name / file_name_not match the entry name exactly (case-insensitive) instead of as a 'contains' wildcard.

folder_name_exactboolean nullable

When true, folder_name / folder_name_not must match a whole folder at any depth: 'data' matches 'a/b/data' but not 'a/b/database'. A value containing slashes matches a whole run of folders ('b/data' matches 'a/b/data/c'). Without it the value is matched as a substring of the folder path.

q_exactboolean nullable

When true, the q term must match on word boundaries: '4.4.4.4' will not match '4.4.4.400'. Applied as a content post-filter (no effect without q).

exclude_termsstring[] nullable

Content terms to exclude: any block whose content contains one of these (substring, case-insensitive) is removed from the results. Min 4 characters per term, max 20 terms. Not a standalone selector: a search using only exclude_terms is rejected, provide q or another positive filter.

ingested_at_minstring date-time nullable

Filter results ingested on or after this datetime (inclusive).

ingested_at_maxstring date-time nullable

Filter results ingested on or before this datetime (inclusive).

Example request

{
  "q": "example.com"
}

Response

Unlock task queued; returns a task_id to poll.

object required

Changes

No recorded changes to this endpoint across all 1 revision of this API.