Getting Started

Use this portal to connect an application to BlueCurve, ingest documents, and build indexing or job plugins.

Obtain access

Your administrator supplies your deployment's HTTPS API address, an API key, and the collections you can access. Use the supplied address in every example; BLUECURVE_API_URL below has no trailing slash.

For REST, send x-api-key and api-version: 1.0. For gRPC, send the API key as metadata over HTTP/2. See Authentication & Security for the required rights.

export BLUECURVE_API_URL='https://YOUR_API_HOST'
export BLUECURVE_API_KEY='YOUR_API_KEY'

curl --fail-with-body "$BLUECURVE_API_URL/collection" \
  -H "x-api-key: $BLUECURVE_API_KEY" \
  -H 'api-version: 1.0'

A successful request returns your collection list. An empty list is valid. Use a key with Write or Admin rights to create a collection.

Choose an integration path

Goal	Start here
Upload and search documents	Ingestion over gRPC, then Search over REST
Extract fields from a custom file format	Indexing plugins
Synchronize an external data source	Provided connectors
Implement scheduled work	Job plugins, then Jobs API
Build conversational integrations	Public MAS API
Wake a custom job from a provider event	Webhook wake-ups

Obtain the SDK for your deployment

Request the matching SDK release and package-feed instructions from your administrator. Releases contain .NET packages and separate Rust, Zig, Kotlin, and Go SDK archives. Use a matching host and SDK release, especially after WASM ABI changes.

For C#, use the supplied BlueCurve.Search.Sdk.Indexer or BlueCurve.Search.Sdk.Job package and its dependencies. Target .NET 10 for the examples in this portal. For WASM, unpack the archive for your language and follow WASM Development for toolchains and build commands.

Deploy and verify a plugin

1. Build an indexing or job example for your language.
2. Add a valid manifest and include runtime dependencies in the ZIP archive.
3. Upload it using the Packaging API with Write or Admin rights.
4. Check the inspection result, then follow any returned task identifier to completion.
5. Ingest a test file or create a job using the installed package ID, then verify the resulting documents with Search.

Next: Core Concepts