Skip to main content
POST
Create AI Filter

Authorizations

x-api-key
string
header
required

API key for authentication (lowercase header name)

Body

application/json

Natural-language prompt used to create or refine a structured filter.

query
string
required

Natural-language filter request from the user.

Example:

"US gmail users with LinkedIn records after 2020"

index
enum<string>

Target search family for field/operator grounding.

Available options:
breach,
docs,
victims,
investigation,
stealer_investigation
Example:

"breach"

filter_id
string

Existing transient AI filter context to refine.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"0123456789abcdef01234567"

Response

200 - application/json

Raw AI filter creation response

Raw AI filter creation response.

filter_id
string

24-character transient filter context ID.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"0123456789abcdef01234567"

filter
object

Recursive structured filter tree.

Constraints:

  • maximum nesting depth: 2
  • maximum leaf conditions: 50
  • each node should use exactly one of field, and, or or
Example: