Skip to main content

Typesense

Overview​

The Typesense connector is a destination connector for sending data into a Typesense cluster.

This connector is currently in development. At this time, the connector can validate credentials during setup, but it does not yet load data into Typesense.

Setup​

Before configuring the connector, you’ll need:

  • A reachable Typesense HTTP(S) endpoint (for example, https://typesense.example.com:8108)
  • A Typesense API key with permission to access the Collections API (used for credential validation)

Authentication​

This connector authenticates using a Typesense API key sent via the x-typesense-api-key header.

During setup, the connector validates credentials by calling:

  • GET /collections

If the request fails (invalid endpoint, network issue, or invalid key), credential validation will fail.

Configuration​

FieldTypeRequiredDescription
endpointstring✅Base URL for your Typesense server. The connector will normalize trailing slashes and then call /collections for validation. Example: https://typesense.example.com:8108
api_keystring✅Typesense API key used to authenticate requests (sent as x-typesense-api-key).

Streams / Data loading behavior​

Data loading is not yet implemented for this destination. Runs will fail with an error indicating that Typesense destination loading is still in development.

When loading support is added, this documentation will be updated with supported object mappings, write modes, and any schema/collection requirements.