Skip to content

Repository files navigation

Tavily

Nuget package dotnet License: MIT Discord

Features 🔥

  • Fully generated C# SDK based on the official Tavily 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 Framework/.Net Standard 2.0
  • Microsoft.Extensions.AI AIFunction tool wrappers for search and extract

Usage

using Tavily;

var apiKey =
    Environment.GetEnvironmentVariable("TAVILY_API_KEY") ??
    throw new InvalidOperationException("TAVILY_API_KEY environment variable is not found.");

using var client = new TavilyClient(apiKey);

Response searchResponse = await client.CreateSearchAsync(
    query: "Who is Leo Messi?");

foreach (var result in searchResponse.Results)
{
    Console.WriteLine($"Title: {result.Title}");
    Console.WriteLine($"Content: {result.Content}");
    Console.WriteLine($"Score: {result.Score}");
    Console.WriteLine($"Url: {result.Url}");
    Console.WriteLine();
}

Microsoft.Extensions.AI

The SDK provides AIFunction wrappers for use with any IChatClient:

using Tavily;
using Microsoft.Extensions.AI;

using var tavilyClient = new TavilyClient(tavilyApiKey);

// Create AI tools for search and extract
AIFunction searchTool = tavilyClient.AsSearchTool();
AIFunction extractTool = tavilyClient.AsExtractTool();

// Use with any IChatClient (OpenAI, Anthropic, Ollama, etc.)
var response = await chatClient.GetResponseAsync(
    [new ChatMessage(ChatRole.User, "Search for the latest .NET 10 features")],
    new ChatOptions { Tools = [searchTool] });

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/Tavily/issues
Priority place for ideas and general questions: https://github.com/tryAGI/Tavily/discussions
Discord: https://discord.gg/Ca2xhfBf3v

Acknowledgments

JetBrains logo

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

About

C# SDK for the Tavily API -- AI-powered search and extraction

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

4 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages

Generated from tryAGI/SdkTemplate