API Reference
AppServerClient
Low-level client for the OpenAI app-server JSON-RPC protocol.
Inheritance
- Object
- AppServerClient
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method AppServerClient.StartAsync
- Property FluentSession.Client
- Method IntelligenceXClient.RequireAppServer
- Property IntelligenceXClient.RawClient
Methods
public Task ArchiveThreadAsync(String threadId, CancellationToken cancellationToken = null) #TaskArchives a thread by id.
Parameters
- threadId System.String
- Thread id.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that completes when the operation finishes.
public Task<JsonValue> CallAsync(String method, JsonObject parameters, CancellationToken cancellationToken = null) #Task<JsonValue>Executes a raw JSON-RPC call.
Parameters
- method System.String
- Method name.
- parameters IntelligenceX.Json.JsonObject
- Optional parameters.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to JsonValue?.
public async Task<CommandExecResult> ExecuteCommandAsync(CommandExecRequest request, CancellationToken cancellationToken = null) #Task<CommandExecResult>Executes a command through the app-server.
Parameters
- request IntelligenceX.OpenAI.AppServer.Models.CommandExecRequest
- Command execution request.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to CommandExecResult.
public async Task<ThreadInfo> ForkThreadAsync(String threadId, CancellationToken cancellationToken = null) #Task<ThreadInfo>Forks a thread by id.
Parameters
- threadId System.String
- Thread id.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to ThreadInfo.
public async Task<HealthCheckResult> HealthCheckAsync(String method = null, Nullable<TimeSpan> timeout = null, CancellationToken cancellationToken = null) #Task<HealthCheckResult>Executes a health check call.
Parameters
- method System.String = null
- Optional method override.
- timeout System.Nullable{System.TimeSpan} = null
- Optional timeout.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to HealthCheckResult.
public async Task InitializeAsync(ClientInfo clientInfo, CancellationToken cancellationToken = null) #TaskInitializes the app-server with client metadata.
Parameters
- clientInfo IntelligenceX.OpenAI.AppServer.ClientInfo
- Client identity information.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that completes when the operation finishes.
public Task InterruptTurnAsync(String threadId, String turnId, CancellationToken cancellationToken = null) #TaskInterrupts an in-flight turn.
Parameters
- threadId System.String
- Thread id.
- turnId System.String
- Turn id.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that completes when the operation finishes.
public async Task<CollaborationModeListResult> ListCollaborationModesAsync(CancellationToken cancellationToken = null) #Task<CollaborationModeListResult>Lists available collaboration modes.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to CollaborationModeListResult.
public async Task<ThreadIdListResult> ListLoadedThreadsAsync(CancellationToken cancellationToken = null) #Task<ThreadIdListResult>Lists currently loaded thread ids.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to ThreadIdListResult.
public async Task<McpServerStatusListResult> ListMcpServerStatusAsync(String cursor = null, Nullable<Int32> limit = null, CancellationToken cancellationToken = null) #Task<McpServerStatusListResult>Lists MCP server status entries, including auth and capability metadata.
Parameters
- cursor System.String = null
- Optional pagination cursor from a previous result.
- limit System.Nullable{System.Int32} = null
- Optional maximum number of items to return in this page.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A McpServerStatusListResult with the current page and optional NextCursor.
Examples
var firstPage = await client.ListMcpServerStatusAsync(limit: 25, cancellationToken: cancellationToken);
foreach (var server in firstPage.Servers) {
Console.WriteLine($"{server.Name}: {server.AuthStatus}");
}
public async Task<ModelListResult> ListModelsAsync(CancellationToken cancellationToken = null) #Task<ModelListResult>Lists available models.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to ModelListResult.
public async Task<SkillListResult> ListSkillsAsync(IReadOnlyList<String> cwds = null, Nullable<Boolean> forceReload = null, CancellationToken cancellationToken = null) #Task<SkillListResult>Lists available skills.
Parameters
- cwds System.Collections.Generic.IReadOnlyList{System.String} = null
- Optional working directories to query.
- forceReload System.Nullable{System.Boolean} = null
- Whether to force reload.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to SkillListResult.
public async Task<ThreadListResult> ListThreadsAsync(String cursor = null, Nullable<Int32> limit = null, String sortKey = null, IReadOnlyList<String> modelProviders = null, CancellationToken cancellationToken = null) #Task<ThreadListResult>Lists threads with optional filters.
Parameters
- cursor System.String = null
- Pagination cursor.
- limit System.Nullable{System.Int32} = null
- Maximum number of items.
- sortKey System.String = null
- Sort key.
- modelProviders System.Collections.Generic.IReadOnlyList{System.String} = null
- Optional model provider filter.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to ThreadListResult.
public Task LoginWithApiKeyAsync(String apiKey, CancellationToken cancellationToken = null) #TaskLogs in using an API key.
Parameters
- apiKey System.String
- API key.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that completes when the operation finishes.
public Task LogoutAsync(CancellationToken cancellationToken = null) #TaskLogs out of the current session.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that completes when the operation finishes.
public Task NotifyAsync(String method, JsonObject parameters, CancellationToken cancellationToken = null) #TaskSends a JSON-RPC notification.
Parameters
- method System.String
- Method name.
- parameters IntelligenceX.Json.JsonObject
- Optional parameters.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that completes when the operation finishes.
public async Task<AccountInfo> ReadAccountAsync(CancellationToken cancellationToken = null) #Task<AccountInfo>Reads account information.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to AccountInfo.
public async Task<ConfigReadResult> ReadConfigAsync(CancellationToken cancellationToken = null) #Task<ConfigReadResult>Reads the effective app-server configuration and layer metadata.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A ConfigReadResult containing merged configuration values, source metadata, and layer details.
Examples
var config = await client.ReadConfigAsync(cancellationToken);
var model = config.Config.GetString("model");
public async Task<ConfigRequirementsReadResult> ReadConfigRequirementsAsync(CancellationToken cancellationToken = null) #Task<ConfigRequirementsReadResult>Reads server-side constraints for configuration values.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A ConfigRequirementsReadResult describing allowed values such as approval policies and sandbox modes.
Examples
var requirements = await client.ReadConfigRequirementsAsync(cancellationToken);
var allowedPolicies = requirements.Requirements?.AllowedApprovalPolicies;
public async Task ReloadMcpServerConfigAsync(CancellationToken cancellationToken = null) #TaskReloads MCP server configuration in the running app-server.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that completes when the reload request is accepted.
Examples
await client.ReloadMcpServerConfigAsync(cancellationToken);
var status = await client.ListMcpServerStatusAsync(cancellationToken: cancellationToken);
public async Task<UserInputResponse> RequestUserInputAsync(IReadOnlyList<String> questions, CancellationToken cancellationToken = null) #Task<UserInputResponse>Requests user input responses.
Parameters
- questions System.Collections.Generic.IReadOnlyList{System.String}
- Questions to prompt.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to UserInputResponse.
public async Task<ThreadInfo> ResumeThreadAsync(String threadId, CancellationToken cancellationToken = null) #Task<ThreadInfo>Resumes a thread by id.
Parameters
- threadId System.String
- Thread id.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to ThreadInfo.
public async Task<ThreadInfo> RollbackThreadAsync(String threadId, Int32 turns, CancellationToken cancellationToken = null) #Task<ThreadInfo>Rolls back a thread by a number of turns.
Parameters
- threadId System.String
- Thread id.
- turns System.Int32
- Number of turns to roll back.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to ThreadInfo.
public static async Task<AppServerClient> StartAsync(AppServerOptions options = null, CancellationToken cancellationToken = null) #Task<AppServerClient>Starts the app-server process and returns a connected client.
Parameters
- options IntelligenceX.OpenAI.AppServer.AppServerOptions = null
- Optional app-server options.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to AppServerClient.
public async Task<ChatGptLoginStart> StartChatGptLoginAsync(CancellationToken cancellationToken = null) #Task<ChatGptLoginStart>Starts a ChatGPT login flow.
Parameters
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to ChatGptLoginStart.
public async Task<McpOauthLoginStart> StartMcpOauthLoginAsync(String serverId, String serverName = null, CancellationToken cancellationToken = null) #Task<McpOauthLoginStart>Starts an MCP OAuth login flow for a configured server.
Parameters
- serverId System.String
- Optional MCP server identifier.
- serverName System.String = null
- Optional MCP server name.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A McpOauthLoginStart containing LoginId and browser AuthUrl.
Examples
var login = await client.StartMcpOauthLoginAsync(serverName: "github", cancellationToken: cancellationToken);
Console.WriteLine(login.AuthUrl);
public async Task<ReviewStartResult> StartReviewAsync(String threadId, String delivery, ReviewTarget target, CancellationToken cancellationToken = null) #Task<ReviewStartResult>Starts a review for a thread.
Parameters
- threadId System.String
- Thread id.
- delivery System.String
- Delivery channel.
- target IntelligenceX.OpenAI.AppServer.Models.ReviewTarget
- Review target.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to ReviewStartResult.
public async Task<ThreadInfo> StartThreadAsync(String model, String currentDirectory = null, String approvalPolicy = null, String sandbox = null, CancellationToken cancellationToken = null) #Task<ThreadInfo>Starts a new chat thread.
Parameters
- model System.String
- Model name.
- currentDirectory System.String = null
- Optional working directory.
- approvalPolicy System.String = null
- Optional approval policy.
- sandbox System.String = null
- Optional sandbox mode.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to ThreadInfo.
public async Task<TurnInfo> StartTurnAsync(String threadId, String text, CancellationToken cancellationToken = null) #Task<TurnInfo>Starts a turn with a text-only input.
Parameters
- threadId System.String
- Thread id.
- text System.String
- Prompt text.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to TurnInfo.
public async Task<TurnInfo> StartTurnAsync(String threadId, String text, String model, String currentDirectory, String approvalPolicy, SandboxPolicy sandboxPolicy, CancellationToken cancellationToken = null) #Task<TurnInfo>Starts a turn with a text-only input and optional overrides.
Parameters
- threadId System.String
- Thread id.
- text System.String
- Prompt text.
- model System.String
- Optional model override.
- currentDirectory System.String
- Optional working directory.
- approvalPolicy System.String
- Optional approval policy.
- sandboxPolicy IntelligenceX.OpenAI.AppServer.SandboxPolicy
- Optional sandbox policy.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to TurnInfo.
public async Task<TurnInfo> StartTurnAsync(String threadId, JsonArray input, String model, String currentDirectory, String approvalPolicy, SandboxPolicy sandboxPolicy, CancellationToken cancellationToken = null) #Task<TurnInfo>Starts a turn with a structured input payload.
Parameters
- threadId System.String
- Thread id.
- input IntelligenceX.Json.JsonArray
- Input items.
- model System.String
- Optional model override.
- currentDirectory System.String
- Optional working directory.
- approvalPolicy System.String
- Optional approval policy.
- sandboxPolicy IntelligenceX.OpenAI.AppServer.SandboxPolicy
- Optional sandbox policy.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that resolves to TurnInfo.
public Task UploadFeedbackAsync(String content, CancellationToken cancellationToken = null) #TaskUploads feedback content.
Parameters
- content System.String
- Feedback content.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that completes when the operation finishes.
public Task WaitForLoginCompletionAsync(String loginId = null, CancellationToken cancellationToken = null) #TaskWaits for a login completion notification.
Parameters
- loginId System.String = null
- Optional login id to match.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that completes when the operation finishes.
public Task WriteConfigBatchAsync(IReadOnlyList<ConfigEntry> entries, CancellationToken cancellationToken = null) #TaskWrites multiple app-server configuration values in a single request.
Parameters
- entries System.Collections.Generic.IReadOnlyList{IntelligenceX.OpenAI.AppServer.Models.ConfigEntry}
- Configuration entries to write as a batch.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that completes when the batch write request is accepted.
Examples
var entries = new[] {
new ConfigEntry("model", JsonConversion.ToJsonValue("gpt-5.4")),
new ConfigEntry("approvalPolicy", JsonConversion.ToJsonValue("on-failure"))
};
await client.WriteConfigBatchAsync(entries, cancellationToken);
public Task WriteConfigValueAsync(String key, JsonValue value, CancellationToken cancellationToken = null) #TaskWrites a single app-server configuration value.
Parameters
- key System.String
- Configuration key to write (for example model).
- value IntelligenceX.Json.JsonValue
- Configuration value encoded as JSON.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that completes when the write request is accepted.
Examples
await client.WriteConfigValueAsync("model", JsonConversion.ToJsonValue("gpt-5.4"), cancellationToken);
public Task WriteSkillConfigAsync(String path, Boolean enabled, CancellationToken cancellationToken = null) #TaskWrites a skill configuration entry.
Parameters
- path System.String
- Skill path.
- enabled System.Boolean
- Whether the skill is enabled.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
A task that completes when the operation finishes.
Inherited Methods
Events
public event EventHandler<JsonRpcNotificationEventArgs> NotificationReceived #Raised when a JSON-RPC notification is received.
public event EventHandler<JsonRpcRequestEventArgs> RequestReceived #Raised when an inbound request is received.
public event EventHandler<Exception> ProtocolError #Raised when a protocol parsing error occurs.
public event EventHandler<String> StandardErrorReceived #Raised when a line is received on standard error.
public event EventHandler<String> ProtocolLineReceived #Raised when a protocol line is received.
public event EventHandler<RpcCallStartedEventArgs> RpcCallStarted #Raised when an RPC call starts.
public event EventHandler<RpcCallCompletedEventArgs> RpcCallCompleted #Raised when an RPC call completes.
public event EventHandler<LoginEventArgs> LoginStarted #Raised when a login flow starts.
public event EventHandler<LoginEventArgs> LoginCompleted #Raised when a login flow completes.