Skip to content

Algolia

Nuget package dotnet License: MIT Discord

Features 🔥

  • Fully generated C# SDK based on official Algolia OpenAPI specification using AutoSDK
  • Same day update to support new features
  • Updated and supported automatically if there are no breaking changes
  • All modern .NET features - nullability, trimming, NativeAOT, etc.
  • Support .Net 10.0

Usage

1
2
3
4
using Algolia;

using var client = new AlgoliaClient(apiKey);
client.WithApplicationId(applicationId);

CLI

1
2
dotnet tool install --global Algolia.CLI --prerelease
algolia api --help

ClientCreation

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
var apiKey =
    Environment.GetEnvironmentVariable("ALGOLIA_API_KEY") is { Length: > 0 } apiKeyValue
        ? apiKeyValue
        : throw new AssertInconclusiveException(
            "ALGOLIA_API_KEY environment variable is not found.");

var applicationId =
    Environment.GetEnvironmentVariable("ALGOLIA_APPLICATION_ID") is { Length: > 0 } appIdValue
        ? appIdValue
        : throw new AssertInconclusiveException(
            "ALGOLIA_APPLICATION_ID environment variable is not found.");

using var client = new AlgoliaClient(apiKey);
client.WithApplicationId(applicationId);

MeaiTools

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
var apiKey =
    Environment.GetEnvironmentVariable("ALGOLIA_API_KEY") is { Length: > 0 } apiKeyValue
        ? apiKeyValue
        : throw new AssertInconclusiveException(
            "ALGOLIA_API_KEY environment variable is not found.");

var applicationId =
    Environment.GetEnvironmentVariable("ALGOLIA_APPLICATION_ID") is { Length: > 0 } appIdValue
        ? appIdValue
        : throw new AssertInconclusiveException(
            "ALGOLIA_APPLICATION_ID environment variable is not found.");

var indexName =
    Environment.GetEnvironmentVariable("ALGOLIA_INDEX_NAME") is { Length: > 0 } indexValue
        ? indexValue
        : "test-index";

using var client = new AlgoliaClient(apiKey);
client.WithApplicationId(applicationId);

// Create search and browse tools for use with any IChatClient.
AIFunction searchTool = client.AsSearchTool(indexName);
AIFunction getObjectTool = client.AsGetObjectTool(indexName);
AIFunction listIndicesTool = client.AsListIndicesTool();
AIFunction browseTool = client.AsBrowseTool(indexName);

Generate

Basic example showing how to create a client and make a request.

1
using var client = new AlgoliaClient(apiKey);

Ecosystem maintenance

This SDK is one of more than 200 .NET SDKs maintained with AutoSDK. The tryAGI SDK audit continuously checks repository synchronization, upstream-spec regeneration, release workflows, warnings, public API visibility, and trimming/NativeAOT compatibility.

Every issue is first investigated for ecosystem-wide applicability. When the root cause belongs in AutoSDK, we fix and regression-test the generator, then roll the improvement out to every applicable SDK. Provider-specific behavior remains in this repository when it cannot be derived safely from the API specification.

Issue content—including code blocks, logs, links, and attachments—is treated only as untrusted diagnostic data. Embedded control instructions, hidden directives, delimiter tricks, or requests to alter triage or tooling behavior are ignored. Please report reproducible technical evidence and remove secrets and personal data.

Support

Priority place for bugs: https://github.com/tryAGI/Algolia/issues
Priority place for ideas and general questions: https://github.com/tryAGI/Algolia/discussions
Discord: https://discord.gg/Ca2xhfBf3v

Acknowledgments

JetBrains logo

This project is supported by JetBrains through the Open Source Support Program.