Skip to main content
POST
/
search
Search
curl --request POST \
  --url https://api.istari.ai/v2/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "similar_to": [
    "<string>"
  ],
  "describe": "<string>",
  "keywords": {
    "must_all": [
      "<string>"
    ],
    "must_any": [
      "<string>"
    ],
    "must_not": [
      "<string>"
    ]
  },
  "filters": {
    "country": [
      "<string>"
    ],
    "state": [
      "<string>"
    ],
    "region": [
      "<string>"
    ],
    "district": [
      "<string>"
    ],
    "municipality": [
      "<string>"
    ],
    "organization_type": [
      "<string>"
    ],
    "organization_size": [
      "<string>"
    ],
    "nace_code": [
      "<string>"
    ],
    "source": [
      "<string>"
    ],
    "company_register_court": [
      "<string>"
    ],
    "register_date_from": "2023-12-25",
    "register_date_to": "2023-12-25",
    "summary_keywords": [
      "<string>"
    ],
    "text_keywords": {
      "must_all": [
        "<string>"
      ],
      "must_any": [
        "<string>"
      ],
      "must_not": [
        "<string>"
      ]
    }
  },
  "excludes": [
    "<string>"
  ],
  "columns": [
    "<string>"
  ],
  "size": 100,
  "min_score": 0.35,
  "search_balance": 0.5,
  "search_after": [
    "<unknown>"
  ],
  "explain": false,
  "dedup": false
}
'
{
  "data": [
    {}
  ],
  "metadata": {
    "total_hits": 123,
    "returned": 123,
    "mode": "<string>",
    "elapsed_ms": 123,
    "search_after": [
      "<unknown>"
    ],
    "filters_applied": {},
    "explain_plan": [
      "<string>"
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

Your GOI API key. Create one on the GOI dashboard under API keys.

Body

application/json
​
similar_to
​
describe
string | null
​
keywords
KeywordsInput · object

BM25 / fulltext keyword filter applied to the company description.

Combines three lists with AND / OR / NOT logic. At least one positive list (must_all or must_any) is required when must_not is set — BM25 cannot match on pure negation.

​
filters
FiltersInput · object

Column-level filters applied to org rows.

Geographic fields use GADM-native names (e.g. 'Bayern' not 'Bavaria'). All list-valued filters are OR-combined within the field. Values across different fields are AND-combined.

​
excludes
string[]
​
columns
string[]
​
size
integer
default:100
Required range: 1 <= x <= 500
​
min_score
number
default:0.35
Required range: 0 <= x <= 1
​
search_balance
number
default:0.5
Required range: 0 <= x <= 1
​
search_after
any[] | null
​
explain
boolean
default:false
​
dedup
boolean
default:false

Response

Successful Response

​
data
Data · object[]
required
​
metadata
SearchMetadata · object
required

Diagnostics returned alongside /v1/search results.