Skip to main content
Version: Current

Get started with the Client SDK

Use this guide to connect a C# application to the IntelliBuddies AI Command Center and retrieve the current user.

Prerequisites​

  • An IntelliBuddies Enterprise Edition deployment accessible from your application.
  • An AI Command Center account with permission to use the required features.
  • IntelliBuddies.Client.API.dll and its dependencies from your AI Command Center installation.
  • A C# project targeting a .NET version supported by that SDK build.

Use the SDK distributed with your server installation. Before choosing your project's target framework, check the installation's SDK dependencies and release notes. Keep the server version, SDK assembly version, and target framework in your integration's deployment notes. Do not assume that examples for one server release apply to every SDK build.

Reference the SDK​

  1. Create a C# console application in Visual Studio.
  2. Set the target framework to a version supported by your installed SDK.
  3. Add a reference to IntelliBuddies.Client.API.dll from the AI Command Center installation directory. Include the dependencies shipped with that SDK and make them available to the application at runtime.
  4. Add the namespaces used by your application:
using IntelliBuddies.Client;
using IntelliBuddies.Client.Models;

The SDK reference pages use types from System, System.Collections, System.Collections.Generic, System.IO, System.Linq, and System.Threading.Tasks where needed. Add these namespaces when copying an example into a project without implicit imports.

Configure the connection​

Set the following environment variables in the environment that launches your application:

VariableValue
INTELLIBUDDIES_SERVER_URLYour AI Command Center base URL, for example https://command-center.example.com.
INTELLIBUDDIES_USERNAMEThe account used by the integration.
INTELLIBUDDIES_PASSWORDThat account's password.

Use your organization's secret store in a deployed application. Do not commit credentials or access tokens to source control. The connection string below demonstrates username/password authentication; the authentication enumeration also lists Windows authentication. Confirm the supported configuration for your deployment before changing authentication modes.

Run your first request​

Replace the console application's Program.cs with the following code after adding the SDK reference:

Program.cs
using System;
using System.Threading.Tasks;
using IntelliBuddies.Client;
using IntelliBuddies.Client.Models;

internal static class Program
{
private static async Task Main()
{
IControlRoomContext context = LoginControlRoom();
try
{
var user = await context.Users.GetCurrentUserAsync();
Console.WriteLine(user == null ? "The request completed without a user result." : "Connected successfully; current user retrieved.");
}
finally
{
context.Close();
}
}

private static IControlRoomContext LoginControlRoom()
{
string RequiredSetting(string name) => Environment.GetEnvironmentVariable(name) ?? throw new InvalidOperationException($"Set {name} before running this example.");
string serverUrl = RequiredSetting("INTELLIBUDDIES_SERVER_URL");
string userName = RequiredSetting("INTELLIBUDDIES_USERNAME");
string password = RequiredSetting("INTELLIBUDDIES_PASSWORD");
string connectionString = $"ServerUrl={serverUrl};UserName={userName};Password={password}";
IControlRoomContext context = new ControlRoomContext(connectionString);
context.Open();
return context;
}
}

With a valid connection and account, the application prints Connected successfully; current user retrieved. This read-only request is a useful first check before running examples that create, update, or delete server entities.

The connection string uses semicolons as delimiters. If a setting contains delimiter characters, consult the installed SDK's connection-string handling rather than inventing an escaping rule.

Use the method examples​

Most method pages provide an example method followed by the shared LoginControlRoom() helper. Place both methods in the same class, add the required namespaces, and configure the environment variables above. Call asynchronous example methods with await. Example IDs, names, paths, and process arguments must be replaced with values from your deployment.

Read SDK usage and troubleshooting for connection lifetime, failure handling, pagination, and job lifecycle guidance.