TopK Client
To setup a TopK client, you’ll need your API key and region:The API key for the project. See below for more details.
The region of the project. Available regions are:
aws-us-east-1-elastica
aws-eu-central-1-monstera
The host of the project.
When using a public host this should always be
true
.
In most cases it is used for internal purposes.The retry configuration for the client.By default, retries occur in two situations:
- When the server requests the client to reduce its request rate, resulting in a
SlowDown
error. - When using the
query(..., lsn=N)
code path.
TopK Client is region-specific.Attempting to access collections or documents outside the specified region will result in a region mismatch error.
API Key
TopK API key is project-specific, so you’ll need to obtain an API key for each individual project. To obtain your API key:1
Go to the TopK Console
You can visit the console here.
2
Authenticate
Log in or create your account.
3
Go to a project
Create a project or use an existing one.
4
Generate an API key
Store your API key in a secure location. It can be viewed only once.
Organization > Project > Collection
hierarchical structure:
TopK with Vite/Webpack SSR
If you’re using the TopK JavaScript SDK in a server-side rendering (SSR) environment, you may need to follow these steps to ensure compatibility:Using with Vite ?
Remix, Nuxt, SvetleKit, Astro ...
Using with Vite ?
Remix, Nuxt, SvetleKit, Astro ...
If you’re using
topk-js
in a Vite project with server-side rendering (SSR), you may need to configure Vite to treat it as an external dependency. This ensures compatibility and prevents build-time issues related to SSR or dependency pre-bundling.Using with Webpack or Turbopack ?
Next.js
Using with Webpack or Turbopack ?
Next.js
If you’re using
topk-js
in a Next.js project (especially with the App Router and Server Components), you may need to mark it as an external package to avoid build issues during server-side bundling.