CoraxAi.ApiClient 2.349.0

Corax AI API Client

Official .NET client for the Corax API, generated from the Corax OpenAPI specification.

The package version tracks the Corax API version it was generated from, so CoraxAi.ApiClient 2.321.0 targets Corax API v2.321.0.

Install

dotnet add package CoraxAi.ApiClient

Requires .NET 8 or later. The package ships both a net8.0 and a net10.0 build, so .NET 10 apps get assemblies and dependencies built for .NET 10. .NET 9 apps resolve the net8.0 build.

Getting started

The client integrates with Microsoft.Extensions.DependencyInjection. Register it once, then inject the API interface you need.

using CoraxAi.ApiClient.Api;
using CoraxAi.ApiClient.Client;
using CoraxAi.ApiClient.Extensions;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

var host = Host.CreateDefaultBuilder(args)
    .ConfigureApi((context, options) =>
    {
        // Pass an empty prefix: ApiKeyToken defaults to "Bearer ", which is not
        // what the X-API-Key header expects.
        options.AddTokens(new ApiKeyToken(
            Environment.GetEnvironmentVariable("CORAX_API_KEY")!,
            ClientUtils.ApiKeyHeader.X_API_Key,
            prefix: ""));

        // The Corax API declares both API-key and bearer security schemes, so every API
        // class takes a provider for each. Register both even when only one is used.
        options.AddTokens(new BearerToken(string.Empty));

        // The OpenAPI specification ships no server list, so the base address is always
        // your Corax deployment's URL.
        options.AddApiHttpClients(client =>
            client.BaseAddress = new Uri(Environment.GetEnvironmentVariable("CORAX_BASE_URL")!));
    })
    .Build();

var projects = host.Services.GetRequiredService<IProjectsApi>();

var response = await projects.ListProjectsAsync(page: 1, size: 20);
foreach (var project in response.Ok()?.Embedded ?? [])
    Console.WriteLine(project.Name);

Paged responses follow HAL: the items are on Embedded, with paging metadata on Page.

To authenticate with a bearer token instead, give BearerToken the real value and leave the API key empty:

options.AddTokens(new BearerToken(accessToken));
options.AddTokens(new ApiKeyToken(string.Empty, ClientUtils.ApiKeyHeader.X_API_Key, prefix: ""));

Responses

Each operation has two forms:

Ok() returns the deserialized success payload, or null if the response was not a success.

var response = await projects.ListProjectsAsync();

if (!response.IsOk)
{
    Console.Error.WriteLine($"{(int)response.StatusCode} {response.ReasonPhrase}");
    return;
}

var page = response.Ok()!;

Retries and timeouts

AddApiHttpClients exposes the IHttpClientBuilder, so Polly policies attach as usual:

options.AddApiHttpClients(
    client => client.BaseAddress = new Uri("https://api.corax.ai"),
    builder => builder
        .AddRetryPolicy(2)
        .AddTimeoutPolicy(TimeSpan.FromSeconds(5))
        .AddCircuitBreakerPolicy(10, TimeSpan.FromSeconds(30)));

Links

• Source and issues
• Release notes
• TypeScript client: @coraxai/api-client

This package is generated; please report problems against the corax-ai-client repository rather than editing the sources directly.