Skip to main content

​
Prerequisites

  • .NET 10 SDK or later (dotnet --version).
  • A tenant subdomain — your Ekso instance (e.g. acme for acme.ekso.app).
  • Either a stored API key (for ApiKeyAuth) or an OAuth token pair (for RefreshableBearerAuth). See Authentication for how to obtain each.

​
Install

From your project directory: 
dotnet add package Ekso.Sdk
Or in your .csproj: 
<PackageReference Include="Ekso.Sdk" Version="0.5.0" />
Pin a major-minor version in production code; the SDK follows semver and may evolve the typed surface in major bumps.

​
Verify

A minimal program that constructs a client and authenticates: 
using Ekso.Sdk;
using Ekso.Sdk.Authentication;

var client = new EksoClient(new EksoClientOptions
{
    Tenant = "acme",
    Auth = new ApiKeyAuth("ek_live_xxx"),
});

// Sanity check — list field definitions on the tenant
var fields = await client.Api.Field.GetAsync();
Console.WriteLine($"Tenant has {fields?.TypeText?.Count ?? 0} text fields configured.");
If the dependency is wired correctly, this compiles and (with a valid API key) prints the count.

​
Dependencies

Ekso.Sdk declares:
PackageWhy
Microsoft.Kiota.AbstractionsCore abstractions for the generated client.
Microsoft.Kiota.Http.HttpClientLibraryDefault HTTP transport.
Microsoft.Kiota.Serialization.JsonJSON request/response (default content type).
Microsoft.Kiota.Serialization.Formapplication/x-www-form-urlencoded (auth flows).
Microsoft.Kiota.Serialization.MultipartMultipart upload (file attachments).
Microsoft.Kiota.Serialization.Texttext/plain responses.
Most of these are transitive — you don’t need to add them to your .csproj. They’re listed so you know what’s actually in your dependency graph.

​
Pre-release builds

To pin a specific pre-release: 
dotnet add package Ekso.Sdk --version 0.5.0
Pre-release versions surface new API operations as soon as the backend ships them. Stable releases gate behind a release cycle that matches the backend’s minor versions.

​
Next steps

  • Authentication — pick ApiKeyAuth or RefreshableBearerAuth.
  • Quickstart — your first authenticated call against the API.