> ## Documentation Index
> Fetch the complete documentation index at: https://docs.istari.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Programmatic access to the ISTARI Global Organization Index (GOI) via API key.

Use it to **discover** organizations (keyword, semantic description, similarity to known domains, or filters alone), **look up** known domains in bulk, and (on eligible tiers) run **aggregations** and read **filter option** lists.

<Tip>
  **Interactive reference:** try endpoints in the [API Playground](/api-reference/search).
</Tip>

<Note>
  Don't have a key yet? Create one under [API keys](/goi/api-keys) in the GOI dashboard.
</Note>

## Base URL

All GOI API paths are under:

```text theme={null}
https://api.istari.ai/v2/
```

Examples:

* `POST https://api.istari.ai/v2/search`
* `POST https://api.istari.ai/v2/fetch`

## Authentication

Every request must include your API key:

```http theme={null}
x-api-key: <your-api-key>
```

Keys are issued for GOI access tiers (`tier_1` or `tier_2`). Quotas and rate limits depend on the tier assigned to your key (see [Reference](/api/goi-reference#rate-limits-and-tiers)).

## Quick example : search

```bash theme={null}
curl --location 'https://api.istari.ai/v2/search' \
  --header 'Accept: application/json' \
  --header 'x-api-key: your-api-key' \
  --header 'Content-Type: application/json' \
  --data '{
    "describe": "SaaS organizations in the US",
    "keywords": {
      "must_all": [],
      "must_any": [],
      "must_not": []
    },
    "filters": {
      "country": ["United States"],
      "state": [],
      "region": [],
      "organization_type": [],
      "organization_size": [],
      "nace_code": []
    },
    "excludes": [],
    "columns": ["domain"],
    "size": 50
  }'
```

## Endpoints at a glance

Paths are relative to **`https://api.istari.ai/v2`**.

| Method | Path               | Purpose                                                                                   |
| ------ | ------------------ | ----------------------------------------------------------------------------------------- |
| `POST` | `/search`          | Search and rank organisations (modes described in [Search](/api/goi-search))              |
| `POST` | `/fetch`           | Bulk lookup by domain list: no scoring ([Fetch, stats & utilities](/api/goi-fetch-stats)) |
| `POST` | `/stats`           | Aggregations (`COUNT` by dimension); monthly quota by tier                                |
| `GET`  | `/filters/options` | Allowed values for categorical filters (scoped to your key)                               |
| `GET`  | `/health`          | Liveness / database check                                                                 |

## Documentation map

* [Search](/api/goi-search): request body, auto-detected modes, keywords, `similar_to`, `describe`, filters, pagination, deduplication
* [Fetch, stats & utilities](/api/goi-fetch-stats): `/fetch`, `/stats`, `/filters/options`, and health
* [Reference: columns, filters, limits & errors](/api/goi-reference): response fields, quotas, HTTP errors