ESC
Ask Kestra AI
ESC
Kestra AI

Hi! I'm your Kestra AI assistant.
Ask me anything about workflows.

EXAMPLE QUESTIONS

How to handle errors & retry on flow?
How to run Python script?
How to write expression for previous tasks outputs?

Typesense DocumentIndex

Typesense DocumentIndex

Certified

Upsert one document into Typesense

Writes a single JSON document to the target collection using Typesense upsert semantics (create or replace).

yaml
type: io.kestra.plugin.typesense.DocumentIndex

Index a document to a Typesense DB

yaml
id: typesense_index_document
namespace: company.team

tasks:
  - id: index_document
    type: io.kestra.plugin.typesense.DocumentIndex
    document: { "countryName":"France", "capital": "Paris", "gdp": 123456}
    apiKey: "{{ secret('TYPESENSE_API_KEY') }}"
    port: 8108
    host: localhost
    collection: Countries
Properties

Typesense API key

Admin or search key used for this request; must allow access to the target collection

Collection name

Name of the Typesense collection; value is rendered before each call

Document body

Map of fields to upsert. Keys must match the collection schema; nested objects are not flattened.

Typesense host

Hostname or IP address of the Typesense cluster node or load balancer

Typesense port

TCP port for the Typesense HTTP API; 8108 is the Typesense default

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Use HTTPS

Default false (HTTP). Set to true to call Typesense over HTTPS/TLS

More Plugins in this Category

Scrapy CLI
Scrapy CLI

Tasks that run Scrapy spiders and CLI commands to scrape data from websites.

Data

1 tasks

Supabase
Supabase

Tasks that call Supabase APIs for data and storage operations.

Data

5 tasks