Search Results for

    Show / Hide Table of Contents

    Class SeclaiClient

    HTTP client for the Seclai REST API. Provides strongly-typed async methods for agents, knowledge bases, memory banks, sources, content, evaluations, solutions, governance, alerts, search, and AI assistants.

    Inheritance
    object
    SeclaiClient
    Implements
    IDisposable
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Seclai
    Assembly: Seclai.dll
    Syntax
    public sealed class SeclaiClient : IDisposable

    Constructors

    SeclaiClient(SeclaiClientOptions)

    Creates a new SeclaiClient from the given options.

    Declaration
    public SeclaiClient(SeclaiClientOptions options)
    Parameters
    Type Name Description
    SeclaiClientOptions options
    Exceptions
    Type Condition
    ConfigurationException

    Thrown when credential options conflict (e.g. both API key and access token).

    Properties

    Typed

    Typed variants of the methods that otherwise return raw JSON.

    Declaration
    public SeclaiTypedClient Typed { get; }
    Property Value
    Type Description
    SeclaiTypedClient
    Remarks

    Opt-in. The methods on the client itself keep returning JsonElement so existing call sites are unaffected; the same endpoints are available here deserialized into models. Both issue exactly the same request — only the return type differs.

    var raw   = await client.SearchAsync("q");        // JsonElement
    var typed = await client.Typed.SearchAsync("q");  // SearchResponse

    Methods

    AcceptAiAssistantPlanAsync(string, AiAssistantAcceptRequest, CancellationToken)

    Accepts a top-level AI assistant plan.

    Declaration
    public Task<AiAssistantAcceptResponse> AcceptAiAssistantPlanAsync(string conversationId, AiAssistantAcceptRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string conversationId
    AiAssistantAcceptRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AiAssistantAcceptResponse>

    AcceptAiMemoryBankSuggestionAsync(string, MemoryBankAcceptRequest, CancellationToken)

    Accepts a top-level AI memory bank suggestion.

    Declaration
    public Task<JsonElement> AcceptAiMemoryBankSuggestionAsync(string conversationId, MemoryBankAcceptRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string conversationId
    MemoryBankAcceptRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    AcceptGovernanceAiPlanAsync(string, CancellationToken)

    Accepts a governance AI plan.

    Declaration
    public Task<GovernanceAiAcceptResponse> AcceptGovernanceAiPlanAsync(string conversationId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string conversationId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<GovernanceAiAcceptResponse>

    AcceptMemoryBankAiSuggestionAsync(string, MemoryBankAcceptRequest, CancellationToken)

    Accepts an AI-generated memory bank suggestion.

    Declaration
    public Task<JsonElement> AcceptMemoryBankAiSuggestionAsync(string conversationId, MemoryBankAcceptRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string conversationId
    MemoryBankAcceptRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    AcceptSolutionAiPlanAsync(string, string, AiAssistantAcceptRequest, CancellationToken)

    Accepts an AI-generated solution plan.

    Declaration
    public Task<AiAssistantAcceptResponse> AcceptSolutionAiPlanAsync(string solutionId, string conversationId, AiAssistantAcceptRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    string conversationId
    AiAssistantAcceptRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AiAssistantAcceptResponse>

    AddAlertCommentAsync(string, AddCommentRequest, CancellationToken)

    Adds a comment to an alert.

    Declaration
    public Task<JsonElement> AddAlertCommentAsync(string alertId, AddCommentRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string alertId
    AddCommentRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    AddEmailDomainAsync(AddEmailDomainRequest, CancellationToken)

    Adds and provisions a vanity subdomain or a custom domain, standing up the SES identity and DNS. Requires an account owner or admin.

    Declaration
    public Task<EmailDomainResponse> AddEmailDomainAsync(AddEmailDomainRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AddEmailDomainRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EmailDomainResponse>

    AddSolutionConversationTurnAsync(string, AddConversationTurnRequest, CancellationToken)

    Adds a conversation turn to a solution.

    Declaration
    public Task<SolutionConversationResponse> AddSolutionConversationTurnAsync(string solutionId, AddConversationTurnRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    AddConversationTurnRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SolutionConversationResponse>

    AiAssistantKnowledgeBaseAsync(AiAssistantGenerateRequest, CancellationToken)

    Generates a knowledge base plan via the top-level AI assistant.

    Declaration
    public Task<AiAssistantGenerateResponse> AiAssistantKnowledgeBaseAsync(AiAssistantGenerateRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AiAssistantGenerateRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AiAssistantGenerateResponse>

    AiAssistantMemoryBankAsync(MemoryBankAiAssistantRequest, CancellationToken)

    Generates a memory bank plan via the top-level AI assistant.

    Declaration
    public Task<MemoryBankAiAssistantResponse> AiAssistantMemoryBankAsync(MemoryBankAiAssistantRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    MemoryBankAiAssistantRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<MemoryBankAiAssistantResponse>

    AiAssistantSolutionAsync(AiAssistantGenerateRequest, CancellationToken)

    Generates a solution plan via the top-level AI assistant.

    Declaration
    public Task<AiAssistantGenerateResponse> AiAssistantSolutionAsync(AiAssistantGenerateRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AiAssistantGenerateRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AiAssistantGenerateResponse>

    AiAssistantSourceAsync(AiAssistantGenerateRequest, CancellationToken)

    Generates a source plan via the top-level AI assistant.

    Declaration
    public Task<AiAssistantGenerateResponse> AiAssistantSourceAsync(AiAssistantGenerateRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AiAssistantGenerateRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AiAssistantGenerateResponse>

    BlockEmailSenderAsync(BlockEmailSenderRequest, CancellationToken)

    Adds a sender address or a whole domain to the account blocklist. Idempotent. Requires an account owner or admin.

    Declaration
    public Task<BlockedEmailSenderResponse> BlockEmailSenderAsync(BlockEmailSenderRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    BlockEmailSenderRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<BlockedEmailSenderResponse>

    CancelAgentRunAsync(string, CancellationToken)

    Cancels an in-progress agent run.

    Declaration
    public Task<AgentRunResponse> CancelAgentRunAsync(string runId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string runId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentRunResponse>
    Remarks

    Cancellation is DELETE on the run resource — the API exposes no POST .../cancel route, and no operation that deletes a run. Rejected when the run has already reached a terminal state.

    CancelExperimentAsync(string, CancellationToken)

    Cancels a running model playground experiment.

    Declaration
    public Task<JsonElement> CancelExperimentAsync(string experimentId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string experimentId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    CancelQueuedEmailRunsAsync(CancellationToken)

    Fails all of the account's QUEUED (over-quota parked) inbound-email runs. Requires an account owner or admin.

    Declaration
    public Task<CancelQueuedRunsResponse> CancelQueuedEmailRunsAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<CancelQueuedRunsResponse>

    CancelSourceEmbeddingMigrationAsync(string, CancellationToken)

    Cancels an in-progress embedding migration.

    Declaration
    public Task<SourceEmbeddingMigrationResponse> CancelSourceEmbeddingMigrationAsync(string sourceId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SourceEmbeddingMigrationResponse>

    CancelSourceExportAsync(string, string, CancellationToken)

    Cancels a source export.

    Declaration
    public Task<ExportResponse> CancelSourceExportAsync(string sourceId, string exportId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    string exportId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<ExportResponse>

    ChangeAlertStatusAsync(string, ChangeStatusRequest, CancellationToken)

    Changes the status of an alert.

    Declaration
    public Task<JsonElement> ChangeAlertStatusAsync(string alertId, ChangeStatusRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string alertId
    ChangeStatusRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    CompactMemoryBankAsync(string, CancellationToken)

    Triggers compaction for a memory bank.

    Declaration
    public Task CompactMemoryBankAsync(string memoryBankId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string memoryBankId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    CreateAgentAsync(CreateAgentRequest, CancellationToken)

    Creates a new agent.

    Declaration
    public Task<AgentSummaryResponse> CreateAgentAsync(CreateAgentRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CreateAgentRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentSummaryResponse>

    CreateAlertConfigAsync(CreateAlertConfigRequest, CancellationToken)

    Creates a new alert configuration.

    Declaration
    public Task<JsonElement> CreateAlertConfigAsync(CreateAlertConfigRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CreateAlertConfigRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    CreateEvaluationCriteriaAsync(string, CreateEvaluationCriteriaRequest, CancellationToken)

    Creates new evaluation criteria for an agent.

    Declaration
    public Task<EvaluationCriteriaResponse> CreateEvaluationCriteriaAsync(string agentId, CreateEvaluationCriteriaRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    CreateEvaluationCriteriaRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EvaluationCriteriaResponse>

    CreateEvaluationResultAsync(string, CreateEvaluationResultRequest, CancellationToken)

    Creates a new evaluation result for criteria.

    Declaration
    public Task<EvaluationResultResponse> CreateEvaluationResultAsync(string criteriaId, CreateEvaluationResultRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string criteriaId
    CreateEvaluationResultRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EvaluationResultResponse>

    CreateExperimentAsync(PlaygroundCreateRequest, CancellationToken)

    Creates a model playground experiment.

    Declaration
    public Task<JsonElement> CreateExperimentAsync(PlaygroundCreateRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    PlaygroundCreateRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    CreateKnowledgeBaseAsync(CreateKnowledgeBaseRequest, CancellationToken)

    Creates a new knowledge base.

    Declaration
    public Task<KnowledgeBaseResponse> CreateKnowledgeBaseAsync(CreateKnowledgeBaseRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CreateKnowledgeBaseRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<KnowledgeBaseResponse>

    CreateMemoryBankAsync(CreateMemoryBankRequest, CancellationToken)

    Creates a new memory bank.

    Declaration
    public Task<MemoryBankResponse> CreateMemoryBankAsync(CreateMemoryBankRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CreateMemoryBankRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<MemoryBankResponse>

    CreateSolutionAsync(CreateSolutionRequest, CancellationToken)

    Creates a new solution.

    Declaration
    public Task<SolutionResponse> CreateSolutionAsync(CreateSolutionRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CreateSolutionRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SolutionResponse>

    CreateSourceAsync(CreateSourceRequest, CancellationToken)

    Creates a new source.

    Declaration
    public Task<SourceResponse> CreateSourceAsync(CreateSourceRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CreateSourceRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SourceResponse>

    CreateSourceExportAsync(string, CreateExportRequest, CancellationToken)

    Creates a new export for a source.

    Declaration
    public Task<ExportResponse> CreateSourceExportAsync(string sourceId, CreateExportRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    CreateExportRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<ExportResponse>

    DeclineAiAssistantPlanAsync(string, CancellationToken)

    Declines a top-level AI assistant plan.

    Declaration
    public Task DeclineAiAssistantPlanAsync(string conversationId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string conversationId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeclineGovernanceAiPlanAsync(string, CancellationToken)

    Declines a governance AI plan.

    Declaration
    public Task DeclineGovernanceAiPlanAsync(string conversationId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string conversationId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeclineSolutionAiPlanAsync(string, string, CancellationToken)

    Declines an AI-generated solution plan.

    Declaration
    public Task DeclineSolutionAiPlanAsync(string solutionId, string conversationId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    string conversationId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeleteAgentAsync(string, CancellationToken)

    Deletes an agent.

    Declaration
    public Task DeleteAgentAsync(string agentId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeleteAgentRunAsync(string, CancellationToken)

    Cancels an agent run.

    Declaration
    [Obsolete("This never deleted anything - the endpoint it calls is documented as \"Cancel an agent run\", and the API has no delete-a-run operation. Use CancelAgentRunAsync instead.")]
    public Task<AgentRunResponse> DeleteAgentRunAsync(string runId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string runId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentRunResponse>

    DeleteAlertConfigAsync(string, CancellationToken)

    Deletes an alert configuration.

    Declaration
    public Task DeleteAlertConfigAsync(string configId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string configId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeleteContentAsync(string, CancellationToken)

    Deletes a content version.

    Declaration
    public Task DeleteContentAsync(string sourceConnectionContentVersion, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceConnectionContentVersion
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeleteEvaluationCriteriaAsync(string, CancellationToken)

    Deletes evaluation criteria.

    Declaration
    public Task DeleteEvaluationCriteriaAsync(string criteriaId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string criteriaId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeleteExperimentAsync(string, CancellationToken)

    Soft-deletes a model playground experiment, removing it from list/detail views while preserving audit history.

    Declaration
    public Task DeleteExperimentAsync(string experimentId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string experimentId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeleteKnowledgeBaseAsync(string, CancellationToken)

    Deletes a knowledge base.

    Declaration
    public Task DeleteKnowledgeBaseAsync(string knowledgeBaseId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string knowledgeBaseId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeleteMemoryBankAsync(string, CancellationToken)

    Deletes a memory bank.

    Declaration
    public Task DeleteMemoryBankAsync(string memoryBankId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string memoryBankId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeleteMemoryBankSourceAsync(string, CancellationToken)

    Deletes the source associated with a memory bank.

    Declaration
    public Task DeleteMemoryBankSourceAsync(string memoryBankId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string memoryBankId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeleteSolutionAsync(string, CancellationToken)

    Deletes a solution.

    Declaration
    public Task DeleteSolutionAsync(string solutionId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeleteSourceAsync(string, CancellationToken)

    Deletes a source.

    Declaration
    public Task DeleteSourceAsync(string sourceId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DeleteSourceExportAsync(string, string, CancellationToken)

    Deletes a source export.

    Declaration
    public Task DeleteSourceExportAsync(string sourceId, string exportId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    string exportId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    DisableAgentAsync(string, CancellationToken)

    Pauses an agent so it stops firing from every trigger path. Returns 409 when other live agents still call this one via a call_agent step.

    Declaration
    public Task<AgentSummaryResponse> DisableAgentAsync(string agentId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentSummaryResponse>

    Dispose()

    Disposes the underlying HttpClient if it was created by this client.

    Declaration
    public void Dispose()

    DownloadAgentRunAttachmentAsync(string, string, string?, CancellationToken)

    Downloads a file attachment emitted by a step in an agent run. Returns the raw HTTP response so the caller can stream the body. The caller must dispose the returned HttpResponseMessage.

    Declaration
    public Task<HttpResponseMessage> DownloadAgentRunAttachmentAsync(string runId, string attachmentId, string? downloadName = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string runId

    Run identifier.

    string attachmentId

    URL-safe-base64-encoded storage_key of the attachment (as surfaced in run output manifests and webhook/email payloads).

    string downloadName

    Optional filename hint for the download disposition.

    CancellationToken cancellationToken

    Cancellation token.

    Returns
    Type Description
    Task<HttpResponseMessage>

    DownloadSourceExportAsync(string, string, CancellationToken)

    Downloads a source export. Returns the raw HTTP response so the caller can stream the body. The caller must dispose the returned HttpResponseMessage.

    Declaration
    public Task<HttpResponseMessage> DownloadSourceExportAsync(string sourceId, string exportId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    string exportId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<HttpResponseMessage>

    EnableAgentAsync(string, CancellationToken)

    Resumes a paused agent, whether paused manually or by the inbound-email overload safeguard.

    Declaration
    public Task<AgentSummaryResponse> EnableAgentAsync(string agentId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentSummaryResponse>

    EstimateSourceExportAsync(string, EstimateExportRequest, CancellationToken)

    Estimates the cost/size of a source export.

    Declaration
    public Task<EstimateExportResponse> EstimateSourceExportAsync(string sourceId, EstimateExportRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    EstimateExportRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EstimateExportResponse>

    ExportAgentAsync(string, bool, CancellationToken)

    Exports an agent definition as a portable JSON snapshot.

    Declaration
    public Task<AgentExportResponse> ExportAgentAsync(string agentId, bool download = true, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    bool download
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentExportResponse>

    GenerateAgentStepsAsync(string, GenerateAgentStepsRequest, CancellationToken)

    Uses the AI assistant to generate step configurations for an agent.

    Declaration
    public Task<GenerateAgentStepsResponse> GenerateAgentStepsAsync(string agentId, GenerateAgentStepsRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    GenerateAgentStepsRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<GenerateAgentStepsResponse>

    GenerateGovernanceAiPlanAsync(GovernanceAiAssistantRequest, CancellationToken)

    Uses the governance AI assistant to generate a plan.

    Declaration
    public Task<GovernanceAiAssistantResponse> GenerateGovernanceAiPlanAsync(GovernanceAiAssistantRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    GovernanceAiAssistantRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<GovernanceAiAssistantResponse>

    GenerateMemoryBankConfigAsync(MemoryBankAiAssistantRequest, CancellationToken)

    Uses the AI assistant to generate memory bank configuration.

    Declaration
    public Task<MemoryBankAiAssistantResponse> GenerateMemoryBankConfigAsync(MemoryBankAiAssistantRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    MemoryBankAiAssistantRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<MemoryBankAiAssistantResponse>

    GenerateSolutionAiKnowledgeBaseAsync(string, AiAssistantGenerateRequest, CancellationToken)

    Uses the AI assistant to generate a knowledge base plan for a solution.

    Declaration
    public Task<AiAssistantGenerateResponse> GenerateSolutionAiKnowledgeBaseAsync(string solutionId, AiAssistantGenerateRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    AiAssistantGenerateRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AiAssistantGenerateResponse>

    GenerateSolutionAiPlanAsync(string, AiAssistantGenerateRequest, CancellationToken)

    Uses the AI assistant to generate a plan for a solution.

    Declaration
    public Task<AiAssistantGenerateResponse> GenerateSolutionAiPlanAsync(string solutionId, AiAssistantGenerateRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    AiAssistantGenerateRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AiAssistantGenerateResponse>

    GenerateSolutionAiSourceAsync(string, AiAssistantGenerateRequest, CancellationToken)

    Uses the AI assistant to generate a source plan for a solution.

    Declaration
    public Task<AiAssistantGenerateResponse> GenerateSolutionAiSourceAsync(string solutionId, AiAssistantGenerateRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    AiAssistantGenerateRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AiAssistantGenerateResponse>

    GenerateStepConfigAsync(string, GenerateStepConfigRequest, CancellationToken)

    Uses the AI assistant to generate configuration for a single step.

    Declaration
    public Task<GenerateStepConfigResponse> GenerateStepConfigAsync(string agentId, GenerateStepConfigRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    GenerateStepConfigRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<GenerateStepConfigResponse>

    GetAgentAiConversationHistoryAsync(string, AiConversationHistoryOptions, CancellationToken)

    Gets the AI assistant conversation history for an agent.

    Declaration
    public Task<AiConversationHistoryResponse> GetAgentAiConversationHistoryAsync(string agentId, AiConversationHistoryOptions options, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    AiConversationHistoryOptions options
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AiConversationHistoryResponse>
    Remarks

    StepType is required by the API — the endpoint answers 422 without it.

    GetAgentAiConversationHistoryAsync(string, CancellationToken)

    Retrieves AI assistant conversation history for an agent.

    Declaration
    [Obsolete("The API requires step_type, which this overload cannot send. Use the AiConversationHistoryOptions overload.")]
    public Task<AiConversationHistoryResponse> GetAgentAiConversationHistoryAsync(string agentId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AiConversationHistoryResponse>
    Remarks

    Deprecated: the API requires a step_type query parameter this signature cannot supply, so every call answers 422. Use the overload taking AiConversationHistoryOptions.

    GetAgentAsync(string, CancellationToken)

    Retrieves an agent by ID.

    Declaration
    public Task<AgentSummaryResponse> GetAgentAsync(string agentId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentSummaryResponse>

    GetAgentAttachmentReferencesAsync(string, CancellationToken)

    Gets the static attachment-reference contract for an agent — what files (if any) its definition expects on a run. Call this before staging uploads to learn whether the agent accepts files at all (RequiresUploads) and which specific filenames, indexes, or glob patterns its templates reference. A run-time upload batch that does not satisfy every declared selector is rejected with HTTP 400.

    Declaration
    public Task<AgentAttachmentRefsApiResponse> GetAgentAttachmentReferencesAsync(string agentId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentAttachmentRefsApiResponse>

    GetAgentCallersAsync(string, CancellationToken)

    Lists the live agents that call this agent via a call_agent step. They must be disabled before this agent can be paused.

    Declaration
    public Task<List<AgentCallerApiResponse>> GetAgentCallersAsync(string agentId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<List<AgentCallerApiResponse>>

    GetAgentDefinitionAsync(string, CancellationToken)

    Retrieves the definition (step configuration) for an agent.

    Declaration
    public Task<AgentDefinitionResponse> GetAgentDefinitionAsync(string agentId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentDefinitionResponse>

    GetAgentInputUploadStatusAsync(string, string, CancellationToken)

    Checks the status of an input upload.

    Declaration
    public Task<UploadAgentInputResponse> GetAgentInputUploadStatusAsync(string agentId, string uploadId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    string uploadId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<UploadAgentInputResponse>

    GetAgentRunAsync(string, bool, CancellationToken)

    Gets an agent run by its run ID, optionally including step outputs.

    Declaration
    public Task<AgentRunResponse> GetAgentRunAsync(string runId, bool includeStepOutputs, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string runId
    bool includeStepOutputs
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentRunResponse>

    GetAgentRunAsync(string, CancellationToken)

    Gets an agent run by its run ID (without step outputs).

    Declaration
    public Task<AgentRunResponse> GetAgentRunAsync(string runId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string runId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentRunResponse>

    GetAgentsUsingMemoryBankAsync(string, CancellationToken)

    Lists agents that use a memory bank.

    Declaration
    public Task<JsonElement> GetAgentsUsingMemoryBankAsync(string memoryBankId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string memoryBankId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    GetAiAssistantMemoryBankHistoryAsync(CancellationToken)

    Retrieves the last AI assistant memory bank conversation.

    Declaration
    public Task<MemoryBankLastConversationResponse> GetAiAssistantMemoryBankHistoryAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<MemoryBankLastConversationResponse>

    GetAlertAsync(string, CancellationToken)

    Retrieves an alert by ID.

    Declaration
    public Task<JsonElement> GetAlertAsync(string alertId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string alertId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    GetAlertConfigAsync(string, CancellationToken)

    Retrieves an alert configuration by ID.

    Declaration
    public Task<JsonElement> GetAlertConfigAsync(string configId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string configId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    GetApiVersionAsync(CancellationToken)

    Reads the API version this request resolved to, and the versions available.

    Declaration
    public Task<ApiVersionResponse> GetApiVersionAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<ApiVersionResponse>
    Remarks

    EffectiveVersion resolves as header, then account pin, then default — so it reflects ApiVersion when that is set.

    GetContentDetailAsync(string, int?, int?, CancellationToken)

    Gets content details with optional text range pagination.

    Declaration
    public Task<ContentDetailResponse> GetContentDetailAsync(string sourceConnectionContentVersion, int? start = null, int? end = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceConnectionContentVersion
    int? start
    int? end
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<ContentDetailResponse>

    GetDmarcSummaryAsync(string, int?, int?, CancellationToken)

    Returns pass rate, disposition breakdown and top failing source IPs from the DMARC aggregate reports.

    Declaration
    public Task<DmarcSummaryResponse> GetDmarcSummaryAsync(string domainId, int? days = null, int? topSources = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string domainId
    int? days
    int? topSources
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<DmarcSummaryResponse>

    GetEvaluationCriteriaAsync(string, CancellationToken)

    Retrieves evaluation criteria by ID.

    Declaration
    public Task<EvaluationCriteriaResponse> GetEvaluationCriteriaAsync(string criteriaId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string criteriaId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EvaluationCriteriaResponse>

    GetEvaluationCriteriaSummaryAsync(string, CancellationToken)

    Retrieves the summary for evaluation criteria.

    Declaration
    public Task<EvaluationResultSummaryResponse> GetEvaluationCriteriaSummaryAsync(string criteriaId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string criteriaId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EvaluationResultSummaryResponse>

    GetExperimentAsync(string, CancellationToken)

    Retrieves a model playground experiment by ID.

    Declaration
    public Task<JsonElement> GetExperimentAsync(string experimentId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string experimentId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    GetGenerationTiersAsync(CancellationToken)

    Lists the media-generation quality tiers and the model and cost each resolves to. Global routing and pricing; read-only.

    Declaration
    public Task<JsonElement> GetGenerationTiersAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    GetInboundEmailStatusAsync(CancellationToken)

    Reports whether the account-wide overload circuit breaker has paused inbound email, plus the queued backlog size.

    Declaration
    public Task<InboundEmailStatusResponse> GetInboundEmailStatusAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<InboundEmailStatusResponse>

    GetKnowledgeBaseAsync(string, CancellationToken)

    Retrieves a knowledge base by ID.

    Declaration
    public Task<KnowledgeBaseResponse> GetKnowledgeBaseAsync(string knowledgeBaseId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string knowledgeBaseId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<KnowledgeBaseResponse>

    GetMeAsync(CancellationToken)

    Gets the authenticated user's personal account ID and the organizations they belong to.

    Declaration
    public Task<MeResponse> GetMeAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<MeResponse>

    GetMemoryBankAiLastConversationAsync(CancellationToken)

    Retrieves the last AI assistant conversation for memory banks.

    Declaration
    public Task<MemoryBankLastConversationResponse> GetMemoryBankAiLastConversationAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<MemoryBankLastConversationResponse>

    GetMemoryBankAsync(string, CancellationToken)

    Retrieves a memory bank by ID.

    Declaration
    public Task<MemoryBankResponse> GetMemoryBankAsync(string memoryBankId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string memoryBankId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<MemoryBankResponse>

    GetMemoryBankStatsAsync(string, CancellationToken)

    Retrieves statistics for a memory bank.

    Declaration
    public Task<JsonElement> GetMemoryBankStatsAsync(string memoryBankId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string memoryBankId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    GetModelAsync(string, CancellationToken)

    Retrieves full details for a specific model.

    Declaration
    public Task<JsonElement> GetModelAsync(string modelId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string modelId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    GetModelRecommendationsAsync(string, CancellationToken)

    Retrieves recommendations for a model.

    Declaration
    public Task<JsonElement> GetModelRecommendationsAsync(string modelId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string modelId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    GetNonManualEvaluationSummaryAsync(string?, CancellationToken)

    Retrieves a summary of non-manual evaluation results.

    Declaration
    public Task<NonManualEvaluationSummaryResponse> GetNonManualEvaluationSummaryAsync(string? agentId = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<NonManualEvaluationSummaryResponse>

    GetSolutionAsync(string, CancellationToken)

    Retrieves a solution by ID.

    Declaration
    public Task<SolutionResponse> GetSolutionAsync(string solutionId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SolutionResponse>

    GetSourceAsync(string, CancellationToken)

    Retrieves a source by ID.

    Declaration
    public Task<SourceResponse> GetSourceAsync(string sourceId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SourceResponse>

    GetSourceEmbeddingMigrationAsync(string, CancellationToken)

    Retrieves the embedding migration status for a source.

    Declaration
    public Task<SourceEmbeddingMigrationResponse> GetSourceEmbeddingMigrationAsync(string sourceId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SourceEmbeddingMigrationResponse>

    GetSourceExportAsync(string, string, CancellationToken)

    Retrieves a source export by ID.

    Declaration
    public Task<ExportResponse> GetSourceExportAsync(string sourceId, string exportId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    string exportId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<ExportResponse>

    GetUnreadModelAlertCountAsync(CancellationToken)

    Retrieves the count of unread model alerts.

    Declaration
    public Task<JsonElement> GetUnreadModelAlertCountAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    LinkAgentsToSolutionAsync(string, LinkResourcesRequest, CancellationToken)

    Links agents to a solution.

    Declaration
    public Task<SolutionResponse> LinkAgentsToSolutionAsync(string solutionId, LinkResourcesRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    LinkResourcesRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SolutionResponse>

    LinkKnowledgeBasesToSolutionAsync(string, LinkResourcesRequest, CancellationToken)

    Links knowledge bases to a solution.

    Declaration
    public Task<SolutionResponse> LinkKnowledgeBasesToSolutionAsync(string solutionId, LinkResourcesRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    LinkResourcesRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SolutionResponse>

    LinkSourceConnectionsToSolutionAsync(string, LinkResourcesRequest, CancellationToken)

    Links source connections to a solution.

    Declaration
    public Task<SolutionResponse> LinkSourceConnectionsToSolutionAsync(string solutionId, LinkResourcesRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    LinkResourcesRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SolutionResponse>

    ListAgentEmailOptOutsAsync(string?, int?, int?, CancellationToken)

    Lists recipients who have opted out of this account's agent emails. Account-wide opt-outs always apply.

    Declaration
    public Task<AgentEmailOptOutListResponse> ListAgentEmailOptOutsAsync(string? agentId = null, int? limit = null, int? offset = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    int? limit
    int? offset
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentEmailOptOutListResponse>

    ListAgentEvaluationResultsAsync(string, int?, int?, CancellationToken)

    Lists all evaluation results for an agent.

    Declaration
    public Task<EvaluationResultWithCriteriaListResponse> ListAgentEvaluationResultsAsync(string agentId, int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EvaluationResultWithCriteriaListResponse>

    ListAgentRunsAsync(string, int?, int?, CancellationToken)

    Lists runs for an agent with optional pagination.

    Declaration
    public Task<AgentRunListResponse> ListAgentRunsAsync(string agentId, int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentRunListResponse>

    ListAgentsAsync(int?, int?, CancellationToken)

    Lists agents.

    Declaration
    public Task<AgentListResponse> ListAgentsAsync(int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentListResponse>

    ListAlertConfigsAsync(int?, int?, CancellationToken)

    Lists alert configurations.

    Declaration
    public Task<JsonElement> ListAlertConfigsAsync(int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>
    Remarks

    The configurations arrive under configs alongside total by default. Once the caller opts in with ApiVersion of 2026-07-27 or later the endpoint returns the canonical {data, pagination} envelope instead, so the top-level key changes.

    ListAlertsAsync(int?, int?, string?, string?, CancellationToken)

    Lists alerts.

    Declaration
    public Task<JsonElement> ListAlertsAsync(int? page = null, int? limit = null, string? status = null, string? severity = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page
    int? limit
    string status
    string severity
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>
    Remarks

    severity: Deprecated and ignored. The API declares no severity filter on this endpoint, so it never filtered anything, and sending it is a 422 once ApiVersion is 2026-07-27 or later. Accepted and dropped so existing call sites keep working.

    ListBlockedEmailSendersAsync(int?, int?, CancellationToken)

    Lists the account's blocked inbound email senders plus the governance auto-block mode. Paginates by limit/offset.

    Declaration
    public Task<BlockedEmailSenderListResponse> ListBlockedEmailSendersAsync(int? limit = null, int? offset = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? limit
    int? offset
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<BlockedEmailSenderListResponse>

    ListCompatibleRunsAsync(string, int?, int?, CancellationToken)

    Lists runs compatible with evaluation criteria.

    Declaration
    public Task<CompatibleRunListResponse> ListCompatibleRunsAsync(string criteriaId, int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string criteriaId
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<CompatibleRunListResponse>

    ListContentEmbeddingsAsync(string, int?, int?, CancellationToken)

    Lists embeddings for a content version with pagination.

    Declaration
    public Task<ContentEmbeddingsListResponse> ListContentEmbeddingsAsync(string sourceConnectionContentVersion, int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceConnectionContentVersion
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<ContentEmbeddingsListResponse>

    ListEmailDomainsAsync(CancellationToken)

    Lists the account's vanity and custom agent-email domains with verification status, required DNS records and plan capabilities.

    Declaration
    public Task<EmailDomainsListResponse> ListEmailDomainsAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EmailDomainsListResponse>

    ListEvaluationCriteriaAsync(string, int?, int?, CancellationToken)

    Lists evaluation criteria for an agent.

    Declaration
    public Task<List<EvaluationCriteriaResponse>> ListEvaluationCriteriaAsync(string agentId, int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<List<EvaluationCriteriaResponse>>
    Remarks

    Accepts either wire shape. The endpoint returned a bare array until 2026-07 and a paginated envelope after, so a client pinned to one of them breaks whenever the other is deployed. Use ListEvaluationCriteriaPageAsync(string, int?, int?, CancellationToken) for the page metadata.

    ListEvaluationCriteriaPageAsync(string, int?, int?, CancellationToken)

    Lists evaluation criteria for an agent with pagination metadata.

    Declaration
    public Task<EvaluationCriteriaListResponse> ListEvaluationCriteriaPageAsync(string agentId, int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EvaluationCriteriaListResponse>
    Remarks

    Pagination is null when the endpoint answers with a bare array rather than the canonical envelope.

    ListEvaluationResultsAsync(string, int?, int?, CancellationToken)

    Lists evaluation results for criteria.

    Declaration
    public Task<EvaluationResultListResponse> ListEvaluationResultsAsync(string criteriaId, int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string criteriaId
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EvaluationResultListResponse>

    ListEvaluationRunsAsync(string, int?, int?, CancellationToken)

    Lists evaluation run summaries for an agent.

    Declaration
    public Task<EvaluationRunSummaryListResponse> ListEvaluationRunsAsync(string agentId, int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EvaluationRunSummaryListResponse>

    ListExperimentsAsync(int?, string?, string?, int?, int?, CancellationToken)

    Lists model playground experiments.

    Declaration
    public Task<JsonElement> ListExperimentsAsync(int? days = null, string? startDate = null, string? endDate = null, int? limit = null, int? offset = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? days
    string startDate
    string endDate
    int? limit
    int? offset
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    ListGovernanceAiConversationsAsync(CancellationToken)

    Lists governance AI assistant conversations.

    Declaration
    public Task<List<GovernanceConversationResponse>> ListGovernanceAiConversationsAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<List<GovernanceConversationResponse>>

    ListInboundEmailRejectionsAsync(string?, int?, CancellationToken)

    Lists recent inbound emails discarded before running an agent — unauthorized sender, unknown alias, spam or flood-shed.

    Declaration
    public Task<List<InboundEmailRejectionResponse>> ListInboundEmailRejectionsAsync(string? agentId = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<List<InboundEmailRejectionResponse>>

    ListKnowledgeBasesAsync(int?, int?, string?, string?, CancellationToken)

    Lists knowledge bases.

    Declaration
    public Task<KnowledgeBaseListResponse> ListKnowledgeBasesAsync(int? page = null, int? limit = null, string? sort = null, string? order = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page
    int? limit
    string sort
    string order
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<KnowledgeBaseListResponse>

    ListMemoryBankTemplatesAsync(CancellationToken)

    Lists available memory bank templates.

    Declaration
    public Task<JsonElement> ListMemoryBankTemplatesAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    ListMemoryBanksAsync(int?, int?, string?, string?, CancellationToken)

    Lists memory banks.

    Declaration
    public Task<MemoryBankListResponse> ListMemoryBanksAsync(int? page = null, int? limit = null, string? sort = null, string? order = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page
    int? limit
    string sort
    string order
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<MemoryBankListResponse>

    ListModelAlertsAsync(int?, int?, CancellationToken)

    Lists model alerts.

    Declaration
    public Task<JsonElement> ListModelAlertsAsync(int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>
    Remarks

    page: 1-indexed page number, translated to the offset the endpoint actually declares. It does not accept page, so every page after the first previously returned page 1.

    ListModelsAsync(string?, bool?, bool?, CancellationToken)

    Lists all enabled LLM models grouped by provider.

    Declaration
    public Task<JsonElement> ListModelsAsync(string? provider = null, bool? supportsToolUse = null, bool? supportsThinking = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string provider
    bool? supportsToolUse
    bool? supportsThinking
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    ListOrganizationAlertPreferencesAsync(CancellationToken)

    Lists organization alert preferences.

    Declaration
    public Task<OrganizationAlertPreferenceListResponse> ListOrganizationAlertPreferencesAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<OrganizationAlertPreferenceListResponse>

    ListRunEvaluationResultsAsync(string, string, int?, int?, CancellationToken)

    Lists evaluation results for a specific run.

    Declaration
    public Task<EvaluationResultWithCriteriaListResponse> ListRunEvaluationResultsAsync(string agentId, string runId, int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    string runId
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EvaluationResultWithCriteriaListResponse>

    ListSolutionConversationsAsync(string, CancellationToken)

    Lists conversations for a solution.

    Declaration
    public Task<List<SolutionConversationResponse>> ListSolutionConversationsAsync(string solutionId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<List<SolutionConversationResponse>>

    ListSolutionsAsync(int?, int?, string?, string?, CancellationToken)

    Lists solutions.

    Declaration
    public Task<SolutionListResponse> ListSolutionsAsync(int? page = null, int? limit = null, string? sort = null, string? order = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page
    int? limit
    string sort
    string order
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SolutionListResponse>

    ListSourceExportsAsync(string, int?, int?, CancellationToken)

    Lists exports for a source.

    Declaration
    public Task<ExportListResponse> ListSourceExportsAsync(string sourceId, int? page = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    int? page
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<ExportListResponse>

    ListSourcesAsync(int?, int?, string?, string?, string?, CancellationToken)

    Lists source connections with optional pagination and sorting.

    Declaration
    public Task<SourceListResponse> ListSourcesAsync(int? page = null, int? limit = null, string? sort = null, string? order = null, string? accountId = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    int? page
    int? limit
    string sort
    string order
    string accountId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SourceListResponse>

    MarkAgentAiSuggestionAsync(string, string, MarkAiSuggestionRequest, CancellationToken)

    Marks an AI assistant suggestion as accepted or rejected.

    Declaration
    public Task MarkAgentAiSuggestionAsync(string agentId, string conversationId, MarkAiSuggestionRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    string conversationId
    MarkAiSuggestionRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    MarkAllModelAlertsReadAsync(CancellationToken)

    Marks all model alerts as read.

    Declaration
    public Task MarkAllModelAlertsReadAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    MarkModelAlertReadAsync(string, CancellationToken)

    Marks a single model alert as read.

    Declaration
    public Task MarkModelAlertReadAsync(string alertId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string alertId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    MarkSolutionConversationTurnAsync(string, string, MarkConversationTurnRequest, CancellationToken)

    Marks a conversation turn as accepted or rejected.

    Declaration
    public Task MarkSolutionConversationTurnAsync(string solutionId, string conversationId, MarkConversationTurnRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    string conversationId
    MarkConversationTurnRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    PreviewImportAgentAsync(AgentImportPreviewRequest, CancellationToken)

    Validates an agent_definition payload (same shape as ExportAgentAsync(string, bool, CancellationToken)'s response) without creating or modifying any agent.

    Use this before CreateAgentAsync(CreateAgentRequest, CancellationToken) or UpdateAgentAsync(string, UpdateAgentRequest, CancellationToken) with an agent_definition to surface UnresolvedRefs — workflow references to knowledge bases, memory banks, source connections, or sub-agents that don't exist in the target account. Pass the returned ids back in EntityRemap on the commit call to substitute them.

    On HTTP 422 the response body is an AgentDefinitionImportErrorResponse listing each field error with a 1-indexed line/column anchored to a canonical source echo. It is delivered as ApiValidationException with the raw body in ResponseBody; deserialize that into AgentDefinitionImportErrorResponse to read the structured fields.

    Declaration
    public Task<AgentImportPreviewResponse> PreviewImportAgentAsync(AgentImportPreviewRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AgentImportPreviewRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentImportPreviewResponse>

    RemoveAgentEmailOptOutAsync(string, CancellationToken)

    Revokes an opt-out, opting the recipient back in to agent emails.

    Declaration
    public Task RemoveAgentEmailOptOutAsync(string optoutId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string optoutId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    RemoveEmailDomainAsync(string, CancellationToken)

    Removes a domain and tears down its SES identity and DNS. Returns a cleanup note when the domain was Seclai-managed.

    Declaration
    public Task<RemoveEmailDomainResponse> RemoveEmailDomainAsync(string domainId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string domainId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<RemoveEmailDomainResponse>

    ReplaceContentWithInlineTextAsync(string, InlineTextReplaceRequest, CancellationToken)

    Replaces content with inline text.

    Declaration
    public Task<ContentFileUploadResponse> ReplaceContentWithInlineTextAsync(string contentVersionId, InlineTextReplaceRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string contentVersionId
    InlineTextReplaceRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<ContentFileUploadResponse>

    ResumeInboundEmailAsync(CancellationToken)

    Manually lifts the account-wide inbound-email pause. One-shot: the breaker re-arms if the backlog is still above the ceiling.

    Declaration
    public Task<ResumeInboundResponse> ResumeInboundEmailAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<ResumeInboundResponse>

    RunAgentAndPollAsync(string, AgentRunRequest, TimeSpan?, TimeSpan?, bool, CancellationToken)

    Runs an agent and polls until it reaches a terminal status (completed or failed).

    Declaration
    public Task<AgentRunResponse> RunAgentAndPollAsync(string agentId, AgentRunRequest body, TimeSpan? pollInterval = null, TimeSpan? timeout = null, bool includeStepOutputs = false, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    AgentRunRequest body
    TimeSpan? pollInterval
    TimeSpan? timeout
    bool includeStepOutputs
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentRunResponse>

    RunAgentAsync(string, AgentRunRequest, CancellationToken)

    Starts a new synchronous agent run.

    Declaration
    public Task<AgentRunResponse> RunAgentAsync(string agentId, AgentRunRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    AgentRunRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentRunResponse>

    RunStreamingAgentAndWaitAsync(string, AgentRunStreamRequest, TimeSpan?, CancellationToken)

    Starts an agent run via SSE streaming and blocks until the final done event.

    Declaration
    public Task<AgentRunResponse> RunStreamingAgentAndWaitAsync(string agentId, AgentRunStreamRequest body, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId

    The agent identifier.

    AgentRunStreamRequest body

    The run request payload.

    TimeSpan? timeout

    Maximum time to wait for completion (default: 60 s).

    CancellationToken cancellationToken

    Cancellation token.

    Returns
    Type Description
    Task<AgentRunResponse>
    Exceptions
    Type Condition
    StreamingException

    Thrown on timeout or if the stream ends without a done event.

    RunStreamingAgentAsync(string, AgentRunStreamRequest, CancellationToken)

    Runs an agent in streaming mode and yields SSE events as they arrive.

    Declaration
    public IAsyncEnumerable<AgentRunEvent> RunStreamingAgentAsync(string agentId, AgentRunStreamRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    AgentRunStreamRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    IAsyncEnumerable<AgentRunEvent>

    SearchAgentRunsAsync(AgentTraceSearchRequest, CancellationToken)

    Searches agent runs with filter criteria.

    Declaration
    public Task<AgentTraceSearchResponse> SearchAgentRunsAsync(AgentTraceSearchRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AgentTraceSearchRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentTraceSearchResponse>

    SearchAsync(string?, int?, string?, CancellationToken)

    Performs a general search across resources.

    Declaration
    public Task<JsonElement> SearchAsync(string? query = null, int? limit = null, string? entityType = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string query
    int? limit
    string entityType
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    SearchDocsAsync(string, string?, int?, CancellationToken)

    Searches the Seclai documentation by content. Mode is keyword (default) or semantic. Results are global, not account-scoped.

    Declaration
    public Task<JsonElement> SearchDocsAsync(string query, string? mode = null, int? limit = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string query
    string mode
    int? limit
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    SendEmailDomainTestEmailAsync(string, CancellationToken)

    Sends a test message from a verified domain to the account owner's address. Never sends anywhere else.

    Declaration
    public Task<SendTestEmailResponse> SendEmailDomainTestEmailAsync(string domainId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string domainId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SendTestEmailResponse>

    SetAutoBlockModeAsync(SetAutoBlockModeRequest, CancellationToken)

    Sets whether a governance BLOCK on an authenticated inbound sender auto-adds them to the blocklist. Requires an account owner or admin.

    Declaration
    public Task<BlockedEmailSenderListResponse> SetAutoBlockModeAsync(SetAutoBlockModeRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    SetAutoBlockModeRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<BlockedEmailSenderListResponse>

    SetEmailTriggerConfigAsync(string, string, SetEmailTriggerConfigRequest, CancellationToken)

    Sets the alias, sender allowlist and inbound-handling flags on an agent's EMAIL_RECEIVED trigger. A null property is left unchanged.

    Declaration
    public Task<EmailTriggerConfigResponse> SetEmailTriggerConfigAsync(string agentId, string triggerId, SetEmailTriggerConfigRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    string triggerId
    SetEmailTriggerConfigRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EmailTriggerConfigResponse>

    SetPrimaryEmailDomainAsync(string, CancellationToken)

    Promotes a verified domain to the account's primary domain, so agent email sends from and receives on it.

    Declaration
    public Task<EmailDomainResponse> SetPrimaryEmailDomainAsync(string domainId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string domainId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EmailDomainResponse>

    StartSourceEmbeddingMigrationAsync(string, StartSourceEmbeddingMigrationRequest, CancellationToken)

    Starts an embedding migration for a source.

    Declaration
    public Task<SourceEmbeddingMigrationResponse> StartSourceEmbeddingMigrationAsync(string sourceId, StartSourceEmbeddingMigrationRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    StartSourceEmbeddingMigrationRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SourceEmbeddingMigrationResponse>

    SubmitAiFeedbackAsync(AiAssistantFeedbackRequest, CancellationToken)

    Submits feedback to the AI assistant.

    Declaration
    public Task<AiAssistantFeedbackResponse> SubmitAiFeedbackAsync(AiAssistantFeedbackRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    AiAssistantFeedbackRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AiAssistantFeedbackResponse>

    SubscribeToAlertAsync(string, CancellationToken)

    Subscribes to an alert.

    Declaration
    public Task<JsonElement> SubscribeToAlertAsync(string alertId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string alertId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    TestCompactionPromptStandaloneAsync(StandaloneTestCompactionRequest, CancellationToken)

    Tests a compaction prompt without a memory bank.

    Declaration
    public Task<CompactionTestResponse> TestCompactionPromptStandaloneAsync(StandaloneTestCompactionRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    StandaloneTestCompactionRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<CompactionTestResponse>

    TestDraftEvaluationAsync(string, TestDraftEvaluationRequest, CancellationToken)

    Tests a draft evaluation criteria without persisting.

    Declaration
    public Task<TestDraftEvaluationResponse> TestDraftEvaluationAsync(string agentId, TestDraftEvaluationRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    TestDraftEvaluationRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<TestDraftEvaluationResponse>

    TestMemoryBankCompactionAsync(string, TestCompactionRequest, CancellationToken)

    Tests compaction for a memory bank.

    Declaration
    public Task<CompactionTestResponse> TestMemoryBankCompactionAsync(string memoryBankId, TestCompactionRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string memoryBankId
    TestCompactionRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<CompactionTestResponse>

    UnblockEmailSenderAsync(string, CancellationToken)

    Removes a blocked sender by ID. Requires an account owner or admin.

    Declaration
    public Task UnblockEmailSenderAsync(string blockedId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string blockedId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    UnlinkAgentsFromSolutionAsync(string, UnlinkResourcesRequest, CancellationToken)

    Unlinks agents from a solution.

    Declaration
    public Task<SolutionResponse> UnlinkAgentsFromSolutionAsync(string solutionId, UnlinkResourcesRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    UnlinkResourcesRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SolutionResponse>

    UnlinkKnowledgeBasesFromSolutionAsync(string, UnlinkResourcesRequest, CancellationToken)

    Unlinks knowledge bases from a solution.

    Declaration
    public Task<SolutionResponse> UnlinkKnowledgeBasesFromSolutionAsync(string solutionId, UnlinkResourcesRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    UnlinkResourcesRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SolutionResponse>

    UnlinkSourceConnectionsFromSolutionAsync(string, UnlinkResourcesRequest, CancellationToken)

    Unlinks source connections from a solution.

    Declaration
    public Task<SolutionResponse> UnlinkSourceConnectionsFromSolutionAsync(string solutionId, UnlinkResourcesRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    UnlinkResourcesRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SolutionResponse>

    UnsubscribeFromAlertAsync(string, CancellationToken)

    Unsubscribes from an alert.

    Declaration
    public Task<JsonElement> UnsubscribeFromAlertAsync(string alertId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string alertId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    UpdateAgentAsync(string, UpdateAgentRequest, CancellationToken)

    Updates an agent.

    Declaration
    public Task<AgentSummaryResponse> UpdateAgentAsync(string agentId, UpdateAgentRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    UpdateAgentRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentSummaryResponse>

    UpdateAgentDefinitionAsync(string, UpdateAgentDefinitionRequest, CancellationToken)

    Updates the definition for an agent.

    Declaration
    public Task<AgentDefinitionResponse> UpdateAgentDefinitionAsync(string agentId, UpdateAgentDefinitionRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    UpdateAgentDefinitionRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<AgentDefinitionResponse>

    UpdateAlertConfigAsync(string, UpdateAlertConfigRequest, CancellationToken)

    Updates an alert configuration.

    Declaration
    public Task<JsonElement> UpdateAlertConfigAsync(string configId, UpdateAlertConfigRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string configId
    UpdateAlertConfigRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    UpdateApiVersionAsync(string?, CancellationToken)

    Pins the account to a dated API version, or clears the pin with null.

    Declaration
    public Task<ApiVersionResponse> UpdateApiVersionAsync(string? version, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string version
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<ApiVersionResponse>
    Remarks

    Owner/admin only. The new pin applies to later header-less requests; a Seclai-Version header still overrides it, so EffectiveVersion in the response describes this request rather than the pin just written.

    UpdateEvaluationCriteriaAsync(string, UpdateEvaluationCriteriaRequest, CancellationToken)

    Updates evaluation criteria.

    Declaration
    public Task<EvaluationCriteriaResponse> UpdateEvaluationCriteriaAsync(string criteriaId, UpdateEvaluationCriteriaRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string criteriaId
    UpdateEvaluationCriteriaRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EvaluationCriteriaResponse>

    UpdateKnowledgeBaseAsync(string, UpdateKnowledgeBaseRequest, CancellationToken)

    Updates a knowledge base.

    Declaration
    public Task<KnowledgeBaseResponse> UpdateKnowledgeBaseAsync(string knowledgeBaseId, UpdateKnowledgeBaseRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string knowledgeBaseId
    UpdateKnowledgeBaseRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<KnowledgeBaseResponse>

    UpdateMemoryBankAsync(string, UpdateMemoryBankRequest, CancellationToken)

    Updates a memory bank.

    Declaration
    public Task<MemoryBankResponse> UpdateMemoryBankAsync(string memoryBankId, UpdateMemoryBankRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string memoryBankId
    UpdateMemoryBankRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<MemoryBankResponse>

    UpdateOrganizationAlertPreferenceAsync(string, string, UpdateOrganizationAlertPreferenceRequest, CancellationToken)

    Updates an organization alert preference.

    Declaration
    public Task<JsonElement> UpdateOrganizationAlertPreferenceAsync(string organizationId, string alertType, UpdateOrganizationAlertPreferenceRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string organizationId
    string alertType
    UpdateOrganizationAlertPreferenceRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<JsonElement>

    UpdateSolutionAsync(string, UpdateSolutionRequest, CancellationToken)

    Updates a solution.

    Declaration
    public Task<SolutionResponse> UpdateSolutionAsync(string solutionId, UpdateSolutionRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string solutionId
    UpdateSolutionRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SolutionResponse>

    UpdateSourceAsync(string, UpdateSourceRequest, CancellationToken)

    Updates a source.

    Declaration
    public Task<SourceResponse> UpdateSourceAsync(string sourceId, UpdateSourceRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceId
    UpdateSourceRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<SourceResponse>

    UploadAgentInputAsync(string, byte[], string, string?, string?, IReadOnlyDictionary<string, object?>?, CancellationToken)

    Uploads an input file for an agent run.

    Declaration
    public Task<UploadAgentInputResponse> UploadAgentInputAsync(string agentId, byte[] fileBytes, string fileName, string? mimeType = null, string? title = null, IReadOnlyDictionary<string, object?>? metadata = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string agentId
    byte[] fileBytes
    string fileName
    string mimeType
    string title
    IReadOnlyDictionary<string, object> metadata
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<UploadAgentInputResponse>

    UploadFileToContentAsync(string, byte[], string, string?, IReadOnlyDictionary<string, object?>?, string?, CancellationToken)

    Upload a file and replace the content backing an existing content version.

    Declaration
    public Task<FileUploadResponse> UploadFileToContentAsync(string sourceConnectionContentVersionId, byte[] fileBytes, string fileName, string? title = null, IReadOnlyDictionary<string, object?>? metadata = null, string? mimeType = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceConnectionContentVersionId
    byte[] fileBytes
    string fileName
    string title
    IReadOnlyDictionary<string, object> metadata
    string mimeType
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<FileUploadResponse>
    Remarks

    This uploads a new file to /contents/{source_connection_content_version}/upload. It behaves like UploadFileToSourceAsync, but targets an existing content version ID.

    UploadFileToContentAsync(string, Stream, string, string?, IReadOnlyDictionary<string, object?>?, string?, CancellationToken)

    Uploads a file from a Stream and replaces the content backing an existing content version.

    Declaration
    public Task<FileUploadResponse> UploadFileToContentAsync(string sourceConnectionContentVersionId, Stream fileStream, string fileName, string? title = null, IReadOnlyDictionary<string, object?>? metadata = null, string? mimeType = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceConnectionContentVersionId
    Stream fileStream
    string fileName
    string title
    IReadOnlyDictionary<string, object> metadata
    string mimeType
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<FileUploadResponse>

    UploadFileToSourceAsync(string, byte[], string, string?, IReadOnlyDictionary<string, object?>?, string?, CancellationToken)

    Upload a file to a specific source connection.

    Declaration
    public Task<FileUploadResponse> UploadFileToSourceAsync(string sourceConnectionId, byte[] fileBytes, string fileName, string? title = null, IReadOnlyDictionary<string, object?>? metadata = null, string? mimeType = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceConnectionId
    byte[] fileBytes
    string fileName
    string title
    IReadOnlyDictionary<string, object> metadata
    string mimeType
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<FileUploadResponse>
    Remarks

    Maximum file size: 200 MiB.

    Supported MIME types:

    • application/epub+zip
    • application/json
    • application/msword
    • application/pdf
    • application/vnd.ms-excel
    • application/vnd.ms-outlook
    • application/vnd.ms-powerpoint
    • application/vnd.openxmlformats-officedocument.presentationml.presentation
    • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
    • application/vnd.openxmlformats-officedocument.wordprocessingml.document
    • application/xml
    • application/zip
    • audio/flac, audio/mp4, audio/mpeg, audio/ogg, audio/wav
    • image/bmp, image/gif, image/jpeg, image/png, image/tiff, image/webp
    • text/csv, text/html, text/markdown, text/x-markdown, text/plain, text/xml
    • video/mp4, video/quicktime, video/x-msvideo

    If mimeType is omitted, the SDK attempts to infer it from fileName. If the upload is sent as application/octet-stream, the server attempts to infer the type from the file extension.

    UploadFileToSourceAsync(string, Stream, string, string?, IReadOnlyDictionary<string, object?>?, string?, CancellationToken)

    Uploads a file from a Stream to a source connection, avoiding loading the full file into memory.

    Declaration
    public Task<FileUploadResponse> UploadFileToSourceAsync(string sourceConnectionId, Stream fileStream, string fileName, string? title = null, IReadOnlyDictionary<string, object?>? metadata = null, string? mimeType = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceConnectionId
    Stream fileStream
    string fileName
    string title
    IReadOnlyDictionary<string, object> metadata
    string mimeType
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<FileUploadResponse>

    UploadInlineTextToSourceAsync(string, InlineTextUploadRequest, CancellationToken)

    Submits inline text content to a source.

    Declaration
    public Task<FileUploadResponse> UploadInlineTextToSourceAsync(string sourceConnectionId, InlineTextUploadRequest body, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string sourceConnectionId
    InlineTextUploadRequest body
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<FileUploadResponse>

    UseSharedEmailDomainAsync(CancellationToken)

    Reverts to the shared agent.seclai.com domain without removing configured domains — they stay verified and can be promoted again.

    Declaration
    public Task UseSharedEmailDomainAsync(CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    CancellationToken cancellationToken
    Returns
    Type Description
    Task

    VerifyEmailDomainAsync(string, CancellationToken)

    Re-polls SES and DNS for this domain now instead of waiting for the background sweep.

    Declaration
    public Task<EmailDomainResponse> VerifyEmailDomainAsync(string domainId, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string domainId
    CancellationToken cancellationToken
    Returns
    Type Description
    Task<EmailDomainResponse>

    Implements

    IDisposable
    In this article
    Back to top Generated by DocFX