Skip to main content
POST
Clean an investment objective

Authorizations

Authorization
string
header
required

Enter 'Bearer' followed by a space and then your JWT or API Key. Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... or Bearer YOUR_API_KEY_HERE

Body

application/json
objective
string
required

The investment objective in natural language.

exclusions
string[]

Exclusion phrases already selected by the user.

regions
string[]

Region filters already selected by the user.

marketCap
string | null

Market-cap catalog key already selected by the user, or null.

availableFilters
object

Catalog of filter options the model may choose from.

Response

The cleaned objective and extracted filters.

cleanedObjective
string

The objective with filter phrases removed, otherwise the original text.

regions
string[]

Selected region options from the provided catalog.

marketCap
string | null

One market-cap catalog key, or null if none applies.

exclusions
string[]

Short exclusion trigger phrases extracted from the objective.

unsupportedFilters
string[]

Subjects of screening conditions the API cannot express, removed from the cleaned objective.