Class Seclai

Seclai JavaScript/TypeScript client.

Provides typed methods for every Seclai API endpoint, plus higher-level abstractions for streaming, polling, and pagination.

Example

import { Seclai } from "@seclai/sdk";

const client = new Seclai({ apiKey: "sk-..." });

// List agents
const { items } = await client.listAgents();

// Run an agent
const run = await client.runAgent("agent-id", { input: "Hello!" });

// Stream an agent run
for await (const event of client.runStreamingAgent("agent-id", { input: "Hello!" })) {
  console.log(event.event, event.data);
}

Index

Constructors

constructor

Methods

acceptAiAssistantPlan acceptAiMemoryBankSuggestion acceptGovernanceAiPlan acceptMemoryBankAiSuggestion acceptSolutionAiPlan addAlertComment addEmailDomain addSolutionConversationTurn aiAssistantKnowledgeBase aiAssistantMemoryBank aiAssistantSolution aiAssistantSource blockEmailSender cancelAgentRun cancelExperiment cancelQueuedEmailRuns cancelSourceEmbeddingMigration cancelSourceExport changeAlertStatus compactMemoryBank createAgent createAlertConfig createEvaluationCriteria createEvaluationResult createExperiment createKnowledgeBase createMemoryBank createSolution createSource createSourceExport declineAiAssistantPlan declineGovernanceAiPlan declineSolutionAiPlan deleteAgent deleteAgentRun deleteAlertConfig deleteContent deleteEvaluationCriteria deleteExperiment deleteKnowledgeBase deleteMemoryBank deleteMemoryBankSource deleteSolution deleteSource deleteSourceExport disableAgent downloadAgentRunAttachment downloadSourceExport enableAgent estimateSourceExport exportAgent generateAgentSteps generateGovernanceAiPlan generateMemoryBankConfig generateSolutionAiKnowledgeBase generateSolutionAiPlan generateSolutionAiSource generateStepConfig getAgent getAgentAiConversationHistory getAgentAttachmentReferences getAgentCallers getAgentDefinition getAgentInputUploadStatus getAgentRun getAgentsUsingMemoryBank getAiAssistantMemoryBankHistory getAlert getAlertConfig getApiVersion getContentDetail getDmarcSummary getEvaluationCriteria getEvaluationCriteriaSummary getExperiment getGenerationTiers getInboundEmailStatus getKnowledgeBase getMe getMemoryBank getMemoryBankAiLastConversation getMemoryBankStats getModel getModelRecommendations getNonManualEvaluationSummary getSolution getSource getSourceEmbeddingMigration getSourceExport getUnreadModelAlertCount linkAgentsToSolution linkKnowledgeBasesToSolution linkSourceConnectionsToSolution listAgentEmailOptOuts listAgentEvaluationResults listAgentRuns listAgents listAlertConfigs listAlerts listBlockedEmailSenders listCompatibleRuns listContentEmbeddings listEmailDomains listEvaluationCriteria listEvaluationCriteriaPage listEvaluationResults listEvaluationRuns listExperiments listGovernanceAiConversations listInboundEmailRejections listKnowledgeBases listMemoryBanks listMemoryBankTemplates listModelAlerts listModels listOrganizationAlertPreferences listRunEvaluationResults listSolutionConversations listSolutions listSourceExports listSources markAgentAiSuggestion markAllModelAlertsRead markModelAlertRead markSolutionConversationTurn paginate previewImportAgent removeAgentEmailOptOut removeEmailDomain replaceContentWithInlineText request requestRaw resumeInboundEmail runAgent runAgentAndPoll runStreamingAgent runStreamingAgentAndWait search searchAgentRuns searchDocs sendEmailDomainTestEmail setAutoBlockMode setEmailTriggerConfig setPrimaryEmailDomain startSourceEmbeddingMigration submitAiFeedback subscribeToAlert testCompactionPromptStandalone testDraftEvaluation testMemoryBankCompaction unblockEmailSender unlinkAgentsFromSolution unlinkKnowledgeBasesFromSolution unlinkSourceConnectionsFromSolution unsubscribeFromAlert updateAgent updateAgentDefinition updateAlertConfig updateApiVersion updateEvaluationCriteria updateKnowledgeBase updateMemoryBank updateOrganizationAlertPreference updateSolution updateSource uploadAgentInput uploadFileToContent uploadFileToSource uploadInlineTextToSource useSharedEmailDomain verifyEmailDomain

Constructors

constructor

new Seclai(opts?: SeclaiOptions): Seclai
Create a new Seclai client.

Credentials are resolved via a chain (first match wins):
1. Explicit apiKey option
2. Explicit accessToken option (static string or provider function)
3. SECLAI_API_KEY environment variable
4. SSO profile from ~/.seclai/config + cached tokens in ~/.seclai/sso/cache/
Parameters
- opts: SeclaiOptions = {}
  Client configuration.
Returns Seclai
Throws
SeclaiConfigurationError If no fetch implementation is available.

Throws
SeclaiConfigurationError If both apiKey and accessToken are provided.
- Defined in client.ts:427

Methods

acceptAiAssistantPlan

acceptAiAssistantPlan(conversationId: string, body: {}): Promise<{}>
Accept an AI assistant suggestion.
Parameters
- conversationId: string
  Conversation identifier.
- body: {}
  Acceptance request payload.
Returns Promise<{}>
- Defined in client.ts:3151

acceptAiMemoryBankSuggestion

acceptAiMemoryBankSuggestion(conversationId: string, body: {}): Promise<{}>
Accept/mark an AI memory bank suggestion.
Parameters
- conversationId: string
  Conversation identifier.
- body: {}
  Acceptance payload for the memory bank suggestion.
Returns Promise<{}>
- Defined in client.ts:3170

acceptGovernanceAiPlan

acceptGovernanceAiPlan(conversationId: string): Promise<{}>
Accept a governance AI plan.
Parameters
- conversationId: string
  Conversation identifier.
Returns Promise<{}>
Acceptance result.
- Defined in client.ts:2593

acceptMemoryBankAiSuggestion

acceptMemoryBankAiSuggestion(conversationId: string, body: {}): Promise<{}>
Accept a memory bank AI suggestion.
Parameters
- conversationId: string
  Conversation identifier.
- body: {}
  Accept request payload.
Returns Promise<{}>
- Defined in client.ts:2060

acceptSolutionAiPlan

acceptSolutionAiPlan(
    solutionId: string,
    conversationId: string,
    body: {},
): Promise<{}>
Accept a solution AI plan.
Parameters
- solutionId: string
  Solution identifier.
- conversationId: string
  Conversation identifier.
- body: {}
  Accept request.
Returns Promise<{}>
Acceptance result with executed actions.
- Defined in client.ts:2552

addAlertComment

addAlertComment(alertId: string, body: {}): Promise<{}>
Add a comment to an alert.
Parameters
- alertId: string
  Alert identifier.
- body: {}
  Comment payload.
Returns Promise<{}>
- Defined in client.ts:2652

addEmailDomain

addEmailDomain(body: AddEmailDomainInput): Promise<{}>
Add and provision a new agent-email domain.

Pass kind: "vanity" with value: "<slug>", or kind: "custom" with value: "agent.mycompany.com" (optionally delegated: true to let Seclai manage a dedicated Route53 zone). Stands up the SES identity + DNS and returns the records the customer must publish. Requires an account owner/admin.
Parameters
- body: AddEmailDomainInput
  The domain to add. delegated defaults to false server-side.
Returns Promise<{}>
- Defined in client.ts:2992

addSolutionConversationTurn

addSolutionConversationTurn(solutionId: string, body: {}): Promise<{}>
Add a conversation turn to a solution.
Parameters
- solutionId: string
  Solution identifier.
- body: {}
  Conversation turn payload.
Returns Promise<{}>
Updated conversation.
- Defined in client.ts:2494

aiAssistantKnowledgeBase

aiAssistantKnowledgeBase(body: {}): Promise<{}>
Generate a knowledge base configuration via AI assistant.
Parameters
- body: {}
  Generation request.
Returns Promise<{}>
- Defined in client.ts:3107

aiAssistantMemoryBank

aiAssistantMemoryBank(body: {}): Promise<{}>
Generate a memory bank configuration via AI assistant.
Parameters
- body: {}
  Generation request.
Returns Promise<{}>
- Defined in client.ts:3134

aiAssistantSolution

aiAssistantSolution(body: {}): Promise<{}>
Generate a solution via AI assistant.
Parameters
- body: {}
  Generation request.
Returns Promise<{}>
- Defined in client.ts:3125

aiAssistantSource

aiAssistantSource(body: {}): Promise<{}>
Generate a source configuration via AI assistant.
Parameters
- body: {}
  Generation request.
Returns Promise<{}>
- Defined in client.ts:3116

blockEmailSender

blockEmailSender(body: {}): Promise<{}>
Add a sender address or a whole domain to the account blocklist.

Idempotent. match_type is "address" (default) or "domain". Requires an account owner/admin.
Parameters
- body: {}
  The sender or domain to block.
Returns Promise<{}>
The blocked-sender entry.
- Defined in client.ts:1778

cancelAgentRun

cancelAgentRun(runId: string): Promise<{}>
Cancel a running agent run.

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.
Parameters
- runId: string
  Run identifier.
Returns Promise<{}>
Updated run (with cancelled status).
- Defined in client.ts:1041

cancelExperiment

cancelExperiment(experimentId: string): Promise<{}>
Cancel a running model playground experiment.
Parameters
- experimentId: string
  Experiment identifier.
Returns Promise<{}>
- Defined in client.ts:2900

cancelQueuedEmailRuns

cancelQueuedEmailRuns(): Promise<{}>
Fail all of the account's QUEUED (over-quota parked) inbound-email runs at once.

A queued run consumed no quota or credits at queue time, so this merely fails them. Requires an account owner/admin.

Returns Promise<{}>
The count cancelled.
- Defined in client.ts:1843

cancelSourceEmbeddingMigration

cancelSourceEmbeddingMigration(sourceId: string): Promise<{}>
Cancel a source embedding migration.
Parameters
- sourceId: string
  Source connection identifier.
Returns Promise<{}>
Updated migration status.
- Defined in client.ts:2272

cancelSourceExport

cancelSourceExport(sourceId: string, exportId: string): Promise<{}>
Cancel a source export.
Parameters
- sourceId: string
  Source connection identifier.
- exportId: string
  Export identifier.
Returns Promise<{}>
- Defined in client.ts:2205

changeAlertStatus

changeAlertStatus(alertId: string, body: {}): Promise<{}>
Change the status of an alert.
Parameters
- alertId: string
  Alert identifier.
- body: {}
  Status change request.
Returns Promise<{}>
- Defined in client.ts:2642

compactMemoryBank

compactMemoryBank(memoryBankId: string): Promise<void>
Compact a memory bank (trigger compaction).
Parameters
- memoryBankId: string
  Memory bank identifier.
Returns Promise<void>
- Defined in client.ts:1996

createAgent

createAgent(body: {}): Promise<{}>
Create a new agent.
Parameters
- body: {}
  Agent creation payload (name, trigger type, template, etc.).
Returns Promise<{}>
Summary of the created agent.
- Defined in client.ts:817

createAlertConfig

createAlertConfig(body: {}): Promise<{}>
Create an alert configuration.
Parameters
- body: {}
  Alert config definition.
Returns Promise<{}>
Created alert config.
- Defined in client.ts:2700

createEvaluationCriteria

createEvaluationCriteria(agentId: string, body: {}): Promise<{}>
Create evaluation criteria for an agent.
Parameters
- agentId: string
  Agent identifier.
- body: {}
  Criteria definition.
Returns Promise<{}>
Created evaluation criteria.
- Defined in client.ts:1571

createEvaluationResult

createEvaluationResult(criteriaId: string, body: {}): Promise<{}>
Create a manual evaluation result for a criteria.
Parameters
- criteriaId: string
  Criteria identifier.
- body: {}
  Evaluation result payload.
Returns Promise<{}>
Created evaluation result.
- Defined in client.ts:1634

createExperiment

createExperiment(body: CreateExperimentInput): Promise<{}>
Create a model playground experiment.
Parameters
- body: CreateExperimentInput
  Experiment configuration.
Returns Promise<{}>
- Defined in client.ts:2882

createKnowledgeBase

createKnowledgeBase(body: {}): Promise<{}>
Create a new knowledge base.
Parameters
- body: {}
  Knowledge base configuration.
Returns Promise<{}>
The created knowledge base.
- Defined in client.ts:1880

createMemoryBank

createMemoryBank(body: {}): Promise<{}>
Create a new memory bank.

Memory banks give agents persistent memory across conversations. Types: conversation (chat-style history) or general (flat factual entries).
Parameters
- body: {}
  Memory bank configuration.
Returns Promise<{}>
The created memory bank.
- Defined in client.ts:1939

createSolution

createSolution(body: {}): Promise<{}>
Create a new solution.
Parameters
- body: {}
  Solution configuration.
Returns Promise<{}>
The created solution.
- Defined in client.ts:2373

createSource

createSource(body: {}): Promise<{}>
Create a new content source.
Parameters
- body: {}
  Source configuration (type, name, knowledge base link, etc.).
Returns Promise<{}>
The created source.
- Defined in client.ts:2094

createSourceExport

createSourceExport(sourceId: string, body: {}): Promise<{}>
Create a source data export.
Parameters
- sourceId: string
  Source connection identifier.
- body: {}
  Export configuration (format, etc.).
Returns Promise<{}>
Export response with job status.
- Defined in client.ts:2184

declineAiAssistantPlan

declineAiAssistantPlan(conversationId: string): Promise<void>
Decline an AI assistant suggestion.
Parameters
- conversationId: string
  Conversation identifier.
Returns Promise<void>
- Defined in client.ts:3160

declineGovernanceAiPlan

declineGovernanceAiPlan(conversationId: string): Promise<void>
Decline a governance AI plan.
Parameters
- conversationId: string
  Conversation identifier.
Returns Promise<void>
- Defined in client.ts:2602

declineSolutionAiPlan

declineSolutionAiPlan(solutionId: string, conversationId: string): Promise<void>
Decline a solution AI plan.
Parameters
- solutionId: string
  Solution identifier.
- conversationId: string
  Conversation identifier.
Returns Promise<void>
- Defined in client.ts:2562

deleteAgent

deleteAgent(agentId: string): Promise<void>
Delete an agent.
Parameters
- agentId: string
  Agent identifier.
Returns Promise<void>
- Defined in client.ts:847

deleteAgentRun

deleteAgentRun(runId: string): Promise<void>
Cancel an agent run.
Parameters
- runId: string
  Run identifier.
Returns Promise<void>
Deprecated
This never deleted anything — the endpoint it calls is documented as "Cancel an agent run", and the API has no delete-a-run operation. It also discards the returned run state. Use cancelAgentRun instead.
- Defined in client.ts:1027

deleteAlertConfig

deleteAlertConfig(configId: string): Promise<void>
Delete an alert configuration.
Parameters
- configId: string
  Alert config identifier.
Returns Promise<void>
- Defined in client.ts:2730

deleteContent

deleteContent(contentVersionId: string): Promise<void>
Delete a specific content version.
Parameters
- contentVersionId: string
  Content version identifier.
Returns Promise<void>
- Defined in client.ts:2311

deleteEvaluationCriteria

deleteEvaluationCriteria(criteriaId: string): Promise<void>
Delete an evaluation criteria and all associated results.
Parameters
- criteriaId: string
  Criteria identifier.
Returns Promise<void>
- Defined in client.ts:1601

deleteExperiment

deleteExperiment(experimentId: string): Promise<void>
Soft-delete a model playground experiment.

Removes the experiment from list/detail views while preserving audit history. Returns HTTP 204 with no body.
Parameters
- experimentId: string
  Experiment identifier.
Returns Promise<void>
- Defined in client.ts:2912

deleteKnowledgeBase

deleteKnowledgeBase(knowledgeBaseId: string): Promise<void>
Delete a knowledge base.
Parameters
- knowledgeBaseId: string
  Knowledge base identifier.
Returns Promise<void>
- Defined in client.ts:1910

deleteMemoryBank

deleteMemoryBank(memoryBankId: string): Promise<void>
Delete a memory bank.
Parameters
- memoryBankId: string
  Memory bank identifier.
Returns Promise<void>
- Defined in client.ts:1969

deleteMemoryBankSource

deleteMemoryBankSource(memoryBankId: string): Promise<void>
Delete a memory bank source.
Parameters
- memoryBankId: string
  Memory bank identifier.
Returns Promise<void>
- Defined in client.ts:2005

deleteSolution

deleteSolution(solutionId: string): Promise<void>
Delete a solution.
Parameters
- solutionId: string
  Solution identifier.
Returns Promise<void>
- Defined in client.ts:2403

deleteSource

deleteSource(sourceId: string): Promise<void>
Delete a source.
Parameters
- sourceId: string
  Source connection identifier.
Returns Promise<void>
- Defined in client.ts:2124

deleteSourceExport

deleteSourceExport(sourceId: string, exportId: string): Promise<void>
Delete a source export.
Parameters
- sourceId: string
  Source connection identifier.
- exportId: string
  Export identifier.
Returns Promise<void>
- Defined in client.ts:2239

disableAgent

disableAgent(agentId: string): Promise<{}>
Pause (disable) an agent so it stops firing from every trigger path.

API runs return HTTP 409, inbound email is turned away, and scheduled / content triggers are skipped.

Fails with HTTP 409 when other live agents still call this one via a call_agent step — use getAgentCallers to list them, and disable those first.
Parameters
- agentId: string
  Agent identifier.
Returns Promise<{}>
The updated agent summary.
- Defined in client.ts:868

downloadAgentRunAttachment

downloadAgentRunAttachment(
    runId: string,
    attachmentId: string,
    opts?: { downloadName?: string },
): Promise<Response>
Download a file attachment emitted by a step in an agent run.

Returns the raw Response so you can stream or save the binary data.
Parameters
- runId: string
  Run identifier.
- attachmentId: string
  URL-safe-base64-encoded storage_key of the attachment (as surfaced in run output manifests and webhook/email payloads).
- opts: { downloadName?: string } = {}
  Optional downloadName filename hint for the download disposition.
Returns Promise<Response>
Raw response with the attachment bytes.
- Defined in client.ts:1451

downloadSourceExport

downloadSourceExport(sourceId: string, exportId: string): Promise<Response>
Download a source export file.

Returns the raw Response so you can stream or save the binary data.
Parameters
- sourceId: string
  Source connection identifier.
- exportId: string
  Export identifier.
Returns Promise<Response>
Raw response with the export file.
- Defined in client.ts:2218

enableAgent

enableAgent(agentId: string): Promise<{}>
Resume (enable) a paused agent.

Clears the disable state whether the agent was paused manually or auto-paused by the inbound-email overload safeguard.
Parameters
- agentId: string
  Agent identifier.
Returns Promise<{}>
The updated agent summary.
- Defined in client.ts:881

estimateSourceExport

estimateSourceExport(sourceId: string, body: {}): Promise<{}>
Estimate a source export.
Parameters
- sourceId: string
  Source connection identifier.
- body: {}
  Estimate request.
Returns Promise<{}>
Export estimate.
- Defined in client.ts:2229

exportAgent

exportAgent(agentId: string, download?: boolean): Promise<{}>
Export an agent definition as a portable JSON snapshot.
Parameters
- agentId: string
  Agent identifier.
- download: boolean = true
  When true (default), the server sets Content-Disposition: attachment.
Returns Promise<{}>
The exported agent snapshot.
- Defined in client.ts:908

generateAgentSteps

generateAgentSteps(agentId: string, body: {}): Promise<{}>
Generate agent workflow steps from natural language using AI.
Parameters
- agentId: string
  Agent identifier.
- body: {}
  Generation request with user instructions.
Returns Promise<{}>
AI-generated step configuration.
- Defined in client.ts:1472

generateGovernanceAiPlan

generateGovernanceAiPlan(body: {}): Promise<{}>
Generate governance policy suggestions using AI.
Parameters
- body: {}
  AI governance request.
Returns Promise<{}>
AI-generated governance suggestions.
- Defined in client.ts:2576

generateMemoryBankConfig

generateMemoryBankConfig(body: {}): Promise<{}>
Generate memory bank configuration using AI.
Parameters
- body: {}
  AI assistant request with user instructions.
Returns Promise<{}>
AI-generated memory bank config.
- Defined in client.ts:2043

generateSolutionAiKnowledgeBase

generateSolutionAiKnowledgeBase(solutionId: string, body: {}): Promise<{}>
Generate a knowledge base configuration via solution AI.
Parameters
- solutionId: string
  Solution identifier.
- body: {}
  Generation request.
Returns Promise<{}>
AI-generated knowledge base config.
- Defined in client.ts:2529

generateSolutionAiPlan

generateSolutionAiPlan(solutionId: string, body: {}): Promise<{}>
Generate a solution AI plan.
Parameters
- solutionId: string
  Solution identifier.
- body: {}
  Generation request.
Returns Promise<{}>
AI-generated plan.
- Defined in client.ts:2518

generateSolutionAiSource

generateSolutionAiSource(solutionId: string, body: {}): Promise<{}>
Generate a source configuration via solution AI.
Parameters
- solutionId: string
  Solution identifier.
- body: {}
  Generation request.
Returns Promise<{}>
AI-generated source config.
- Defined in client.ts:2540

generateStepConfig

generateStepConfig(agentId: string, body: {}): Promise<{}>
Generate a single step configuration using AI.
Parameters
- agentId: string
  Agent identifier.
- body: {}
  Step config generation request.
Returns Promise<{}>
AI-generated step config.
- Defined in client.ts:1483

getAgent

getAgent(agentId: string): Promise<{}>
Get agent details including its definition.
Parameters
- agentId: string
  Agent identifier.
Returns Promise<{}>
Full agent metadata.
- Defined in client.ts:827

getAgentAiConversationHistory

getAgentAiConversationHistory(
    agentId: string,
    opts?: {
        limit?: number;
        offset?: number;
        stepId?: string;
        stepType?: string;
    },
): Promise<{}>
Get AI conversation history for an agent.
Parameters
- agentId: string
  Agent identifier.
- opts: { limit?: number; offset?: number; stepId?: string; stepType?: string } = {}
Returns Promise<{}>
Conversation history.
- Defined in client.ts:1493

getAgentAttachmentReferences

getAgentAttachmentReferences(agentId: string): Promise<{}>
Get 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 (requires_uploads) and which specific filenames, indexes, or glob patterns its templates reference. A run-time upload batch that doesn't satisfy every declared selector is rejected with HTTP 400.
Parameters
- agentId: string
  Agent identifier.
Returns Promise<{}>
The agent's attachment-reference contract.
- Defined in client.ts:1436

getAgentCallers

getAgentCallers(agentId: string): Promise<{}[]>
List the live agents that call this agent via a call_agent step.

These must be disabled before this agent can be paused.
Parameters
- agentId: string
  Agent identifier.
Returns Promise<{}[]>
The calling agents.
- Defined in client.ts:893

getAgentDefinition

getAgentDefinition(agentId: string): Promise<{}>
Get an agent's full definition (steps, model config, etc.).
Parameters
- agentId: string
  Agent identifier.
Returns Promise<{}>
The agent definition.
- Defined in client.ts:946

getAgentInputUploadStatus

getAgentInputUploadStatus(agentId: string, uploadId: string): Promise<{}>
Get the status of an agent input upload.
Parameters
- agentId: string
  Agent identifier.
- uploadId: string
  Upload identifier.
Returns Promise<{}>
Upload status and metadata.
- Defined in client.ts:1420

getAgentRun

getAgentRun(runId: string, opts?: { includeStepOutputs?: boolean }): Promise<{}>
Get details of a specific agent run.
Parameters
- runId: string
  Run identifier.
- Optionalopts: { includeStepOutputs?: boolean }
  Optional flags.
Returns Promise<{}>
Agent run details.
- Defined in client.ts:1009

getAgentsUsingMemoryBank

getAgentsUsingMemoryBank(memoryBankId: string): Promise<unknown>
Get agents that are using a specific memory bank.
Parameters
- memoryBankId: string
  Memory bank identifier.
Returns Promise<unknown>
- Defined in client.ts:1978

getAiAssistantMemoryBankHistory

getAiAssistantMemoryBankHistory(): Promise<{}>
Get AI assistant memory bank conversation history.

Returns Promise<{}>
- Defined in client.ts:3141

getAlert

getAlert(alertId: string): Promise<{}>
Get alert details by ID.
Parameters
- alertId: string
  Alert identifier.
Returns Promise<{}>
Alert details.
- Defined in client.ts:2632

getAlertConfig

getAlertConfig(configId: string): Promise<{}>
Get an alert configuration by ID.
Parameters
- configId: string
  Alert config identifier.
Returns Promise<{}>
Alert config details.
- Defined in client.ts:2710

getApiVersion

getApiVersion(): Promise<{}>
Read the API version this request resolved to, and the versions available.

Resolution order is the Seclai-Version header, then the account pin, then the default — so effective_version reflects the client's apiVersion option when that is set.

Returns Promise<{}>
The pinned, effective, default and latest versions.
- Defined in client.ts:777

getContentDetail

getContentDetail(
contentVersionId: string,
opts?: { end?: number; start?: number },
): Promise<{}>
Get content detail for a specific content version.
Parameters
- contentVersionId: string
  Content version identifier.
- opts: { end?: number; start?: number } = {}
  Range options for slicing large content.
Returns Promise<{}>
Content details for the requested range.
- Defined in client.ts:2287

getDmarcSummary

getDmarcSummary(
domainId: string,
opts?: { days?: number; topSources?: number },
): Promise<{}>
Get the DMARC aggregate-report summary for a domain.

Pass rate, disposition breakdown (none/quarantine/reject), and top failing source IPs from the DMARC rua reports over the last days (clamped by the service).

Populated for domains whose DNS zone Seclai controls (vanity + delegated custom); a self-managed custom domain keeps its own DMARC reporting and returns an all-zero summary.
Parameters
- domainId: string
  Domain identifier.
- opts: { days?: number; topSources?: number } = {}
  Reporting window options.
  - Optionaldays?: number
    Window length in days (default 30).
  - OptionaltopSources?: number
    Number of top failing sources to return (default 10).
Returns Promise<{}>
- Defined in client.ts:3079

getEvaluationCriteria

getEvaluationCriteria(criteriaId: string): Promise<{}>
Get a single evaluation criteria by ID.
Parameters
- criteriaId: string
  Criteria identifier.
Returns Promise<{}>
Evaluation criteria details.
- Defined in client.ts:1581

getEvaluationCriteriaSummary

getEvaluationCriteriaSummary(criteriaId: string): Promise<{}>
Get the evaluation summary for a specific criteria.
Parameters
- criteriaId: string
  Criteria identifier.
Returns Promise<{}>
Evaluation result summary.
- Defined in client.ts:1611

getExperiment

getExperiment(experimentId: string): Promise<{}>
Get a model playground experiment by ID.
Parameters
- experimentId: string
  Experiment identifier.
Returns Promise<{}>
- Defined in client.ts:2891

getGenerationTiers

getGenerationTiers(): Promise<Record<string, unknown>>
List the media-generation quality tiers and the model + cost each resolves to.

On a prompt_call's media_generation tool — and the dedicated generate_* steps via tier routing — the author/LLM picks a tier (fast/balanced/thorough), never a model. This maps each (modality, tier) to its concrete generator, raw credits_per_unit, unit_label, and a human-readable scaled price_label.

Global routing/pricing (the same for every account); read-only.

Returns Promise<Record<string, unknown>>
- Defined in client.ts:2858

getInboundEmailStatus

getInboundEmailStatus(): Promise<{}>
Get the account's inbound-email overload status — whether the circuit breaker has paused new inbound email, and the size of the QUEUED (over-quota parked) run backlog.

Returns Promise<{}>
- Defined in client.ts:1830

getKnowledgeBase

getKnowledgeBase(knowledgeBaseId: string): Promise<{}>
Get a knowledge base by ID.
Parameters
- knowledgeBaseId: string
  Knowledge base identifier.
Returns Promise<{}>
Knowledge base details.
- Defined in client.ts:1890

getMe

getMe(): Promise<{}>
Get the authenticated user's identity.

Returns the personal account_id plus every organization the user belongs to — each with its own id, display name, and account_id. Use it to discover the account IDs that can be passed as the client's accountId option (sent as the X-Account-Id header) to target an org context.

Returns Promise<{}>
The current user's account ID and organization memberships.
- Defined in client.ts:760

getMemoryBank

getMemoryBank(memoryBankId: string): Promise<{}>
Get a memory bank by ID.
Parameters
- memoryBankId: string
  Memory bank identifier.
Returns Promise<{}>
Memory bank details.
- Defined in client.ts:1949

getMemoryBankAiLastConversation

getMemoryBankAiLastConversation(): Promise<{}>
Get the last AI conversation for memory banks.

Returns Promise<{}>
- Defined in client.ts:2050

getMemoryBankStats

getMemoryBankStats(memoryBankId: string): Promise<unknown>
Get stats for a memory bank.
Parameters
- memoryBankId: string
  Memory bank identifier.
Returns Promise<unknown>
- Defined in client.ts:1987

getModel

getModel(modelId: string): Promise<{}>
Get full details for a specific model.
Parameters
- modelId: string
  Model identifier.
Returns Promise<{}>
- Defined in client.ts:2843

getModelRecommendations

getModelRecommendations(modelId: string): Promise<{}>
Get model recommendations.
Parameters
- modelId: string
  Model identifier.
Returns Promise<{}>
- Defined in client.ts:2809

getNonManualEvaluationSummary

getNonManualEvaluationSummary(agentId: string): Promise<{}>
Get a summary of non-manual evaluations across an agent's runs.
Parameters
- agentId: string
  Agent identifier.
Returns Promise<{}>
- Defined in client.ts:1690

getSolution

getSolution(solutionId: string): Promise<{}>
Get a solution by ID.
Parameters
- solutionId: string
  Solution identifier.
Returns Promise<{}>
Solution details.
- Defined in client.ts:2383

getSource

getSource(sourceId: string): Promise<{}>
Get a source by ID.
Parameters
- sourceId: string
  Source connection identifier.
Returns Promise<{}>
Source details.
- Defined in client.ts:2104

getSourceEmbeddingMigration

getSourceEmbeddingMigration(sourceId: string): Promise<{}>
Get the status of a source embedding migration.
Parameters
- sourceId: string
  Source connection identifier.
Returns Promise<{}>
Migration status.
- Defined in client.ts:2251

getSourceExport

getSourceExport(sourceId: string, exportId: string): Promise<{}>
Get a specific source export.
Parameters
- sourceId: string
  Source connection identifier.
- exportId: string
  Export identifier.
Returns Promise<{}>
Export details.
- Defined in client.ts:2195

getUnreadModelAlertCount

getUnreadModelAlertCount(): Promise<{}>
Get unread model alert count.

Returns Promise<{}>
- Defined in client.ts:2791

linkAgentsToSolution

linkAgentsToSolution(solutionId: string, body: {}): Promise<{}>
Link agents to a solution.
Parameters
- solutionId: string
  Solution identifier.
- body: {}
  Resource IDs to link.
Returns Promise<{}>
Updated solution.
- Defined in client.ts:2416

linkKnowledgeBasesToSolution

linkKnowledgeBasesToSolution(solutionId: string, body: {}): Promise<{}>
Link knowledge bases to a solution.
Parameters
- solutionId: string
  Solution identifier.
- body: {}
  Resource IDs to link.
Returns Promise<{}>
Updated solution.
- Defined in client.ts:2438

linkSourceConnectionsToSolution

linkSourceConnectionsToSolution(solutionId: string, body: {}): Promise<{}>
Link source connections to a solution.
Parameters
- solutionId: string
  Solution identifier.
- body: {}
  Resource IDs to link.
Returns Promise<{}>
Updated solution.
- Defined in client.ts:2460

listAgentEmailOptOuts

listAgentEmailOptOuts(
opts?: { agentId?: string; limit?: number; offset?: number },
): Promise<{}>
List recipients who have opted out of this account's agent emails.
Parameters
- opts: { agentId?: string; limit?: number; offset?: number } = {}
  Optional agent filter and limit/offset pagination.
  - OptionalagentId?: string
    Filter to one agent (account-wide opt-outs still apply).
  - Optionallimit?: number
    Page size (1-200, default 50).
  - Optionaloffset?: number
    Rows to skip (default 0).
Returns Promise<{}>
The page of opt-outs plus the total count.
- Defined in client.ts:1736

listAgentEvaluationResults

listAgentEvaluationResults(
agentId: string,
opts?: ListOptions,
): Promise<EvaluationResultWithCriteriaListResponse>
List all evaluation results for an agent.
Parameters
- agentId: string
  Agent identifier.
- opts: ListOptions = {}
  Pagination options.
Returns Promise<EvaluationResultWithCriteriaListResponse>
- Defined in client.ts:1667

listAgentRuns

listAgentRuns(
agentId: string,
opts?: ListOptions & { status?: string },
): Promise<{}>
List runs for a specific agent.
Parameters
- agentId: string
  Agent identifier.
- opts: ListOptions & { status?: string } = {}
  Pagination and filter options.
Returns Promise<{}>
Paginated list of runs.
- Defined in client.ts:983

listAgents

listAgents(opts?: ListOptions): Promise<{}>
List agents.
Parameters
- opts: ListOptions = {}
  Pagination options.
Returns Promise<{}>
Paginated list of agents.
- Defined in client.ts:805

listAlertConfigs

listAlertConfigs(opts?: ListOptions): Promise<AlertConfigListResponse>
The configurations arrive under configs alongside total by default. Once the caller opts in with apiVersion 2026-07-27 or later the endpoint returns the canonical {data, pagination} envelope instead, so the top-level key changes.
Parameters
- opts: ListOptions = {}
Returns Promise<AlertConfigListResponse>
- Defined in client.ts:2688

listAlerts

listAlerts(
opts?: ListOptions & { severity?: string; status?: string },
): Promise<{}>
List alerts.
Parameters
- opts: ListOptions & { severity?: string; status?: string } = {}
  Pagination and filter options.
Returns Promise<{}>
Paginated list of alerts.
- Defined in client.ts:2616

listBlockedEmailSenders

listBlockedEmailSenders(opts?: { limit?: number; offset?: number }): Promise<{}>
List the account's blocked inbound email senders (newest first), plus the governance auto_block_mode.
Parameters
- opts: { limit?: number; offset?: number } = {}
  Optional limit/offset pagination.
  - Optionallimit?: number
    Page size (1-200, default 50).
  - Optionaloffset?: number
    Rows to skip (default 0).
Returns Promise<{}>
- Defined in client.ts:1761

listCompatibleRuns

listCompatibleRuns(criteriaId: string, opts?: ListOptions): Promise<{}>
List runs compatible with a specific evaluation criteria.
Parameters
- criteriaId: string
  Criteria identifier.
- opts: ListOptions = {}
  Pagination options.
Returns Promise<{}>
- Defined in client.ts:1644

listContentEmbeddings

listContentEmbeddings(contentVersionId: string, opts?: ListOptions): Promise<{}>
List embeddings for a content version.
Parameters
- contentVersionId: string
  Content version identifier.
- opts: ListOptions = {}
  Pagination options.
Returns Promise<{}>
Paginated list of embeddings.
- Defined in client.ts:2322

listEmailDomains

listEmailDomains(): Promise<{}>
List the account's vanity (<slug>.seclai.com) and custom (agent.mycompany.com) agent-email domains.

Includes each domain's verification status and the DNS records the customer must publish, plus the plan capabilities (can_add_vanity / can_add_custom) and whether one of each kind already exists (has_vanity / has_custom — the per-kind limit is 1).

Requires a user-bound credential; an account-only API key is refused with 403.

Returns Promise<{}>
- Defined in client.ts:2977

listEvaluationCriteria

listEvaluationCriteria(agentId: string, opts?: ListOptions): Promise<{}[]>
List evaluation criteria for an agent.
Parameters
- agentId: string
  Agent identifier.
- opts: ListOptions = {}
  Pagination options.
Returns Promise<{}[]>
- Defined in client.ts:1538

listEvaluationCriteriaPage

listEvaluationCriteriaPage(
agentId: string,
opts?: ListOptions,
): Promise<EvaluationCriteriaListResponse>
List evaluation criteria for an agent, with pagination metadata.

Accepts either wire shape. The endpoint answered with a bare array before 2026-07 and with a paginated envelope after, so a client that decodes only one breaks the day the other ships. total, page and limit are absent when the endpoint answers with a bare array.
Parameters
- agentId: string
  Agent identifier.
- opts: ListOptions = {}
  Pagination options.
Returns Promise<EvaluationCriteriaListResponse>
The criteria under data, plus the page metadata when present.
- Defined in client.ts:1554

listEvaluationResults

listEvaluationResults(criteriaId: string, opts?: ListOptions): Promise<{}>
List evaluation results for a specific criteria.
Parameters
- criteriaId: string
  Criteria identifier.
- opts: ListOptions = {}
  Pagination options.
Returns Promise<{}>
- Defined in client.ts:1621

listEvaluationRuns

listEvaluationRuns(agentId: string, opts?: ListOptions): Promise<{}>
List evaluation run summaries for an agent.
Parameters
- agentId: string
  Agent identifier.
- opts: ListOptions = {}
  Pagination options.
Returns Promise<{}>
- Defined in client.ts:1679

listExperiments

listExperiments(
    opts?: {
        days?: number;
        endDate?: string;
        limit?: number;
        offset?: number;
        startDate?: string;
    },
): Promise<{}>
List model playground experiments.
Parameters
- opts: {
      days?: number;
      endDate?: string;
      limit?: number;
      offset?: number;
      startDate?: string;
  } = {}
  Optional filters and pagination.
Returns Promise<{}>
- Defined in client.ts:2871

listGovernanceAiConversations

listGovernanceAiConversations(): Promise<{}[]>
List governance AI conversations.

Returns Promise<{}[]>
- Defined in client.ts:2583

listInboundEmailRejections

listInboundEmailRejections(
opts?: { agentId?: string; limit?: number },
): Promise<{}[]>
List recent inbound emails that were quietly discarded before running an agent (unauthorized sender, unknown alias, spam/virus, flood-shed).
Parameters
- opts: { agentId?: string; limit?: number } = {}
  Optional agent filter and result limit.
  - OptionalagentId?: string
    Filter to a single agent's rejections.
  - Optionallimit?: number
    Maximum results (1-200, default 50).
Returns Promise<{}[]>
- Defined in client.ts:1817

listKnowledgeBases

listKnowledgeBases(opts?: SortableListOptions): Promise<{}>
List knowledge bases.
Parameters
- opts: SortableListOptions = {}
  Pagination and sorting options.
Returns Promise<{}>
Paginated list of knowledge bases.
- Defined in client.ts:1868

listMemoryBanks

listMemoryBanks(opts?: SortableListOptions): Promise<{}>
List memory banks.
Parameters
- opts: SortableListOptions = {}
  Pagination and sorting options.
Returns Promise<{}>
Paginated list of memory banks.
- Defined in client.ts:1924

listMemoryBankTemplates

listMemoryBankTemplates(): Promise<unknown>
List available memory bank templates.

Returns Promise<unknown>
- Defined in client.ts:2031

listModelAlerts

listModelAlerts(opts?: ListOptions): Promise<ModelAlertListResponse>
List model alerts.
Parameters
- opts: ListOptions = {}
  Pagination options.
Returns Promise<ModelAlertListResponse>
- Defined in client.ts:2771

listModels

listModels(
    opts?: {
        provider?: string;
        supportsInputMedia?: string;
        supportsOutputMedia?: string;
        supportsThinking?: boolean;
        supportsToolUse?: boolean;
    },
): Promise<{}[]>
List all enabled LLM models grouped by provider.
Parameters
- opts: {
      provider?: string;
      supportsInputMedia?: string;
      supportsOutputMedia?: string;
      supportsThinking?: boolean;
      supportsToolUse?: boolean;
  } = {}
  Optional filters.
Returns Promise<{}[]>
- Defined in client.ts:2818

listOrganizationAlertPreferences

listOrganizationAlertPreferences(): Promise<{}>
List organization alert preferences.

Returns Promise<{}>
- Defined in client.ts:2739

listRunEvaluationResults

listRunEvaluationResults(
    agentId: string,
    runId: string,
    opts?: ListOptions,
): Promise<EvaluationResultWithCriteriaListResponse>
List evaluation results for a specific agent run.
Parameters
- agentId: string
  Agent identifier.
- runId: string
  Run identifier.
- opts: ListOptions = {}
  Pagination options.
Returns Promise<EvaluationResultWithCriteriaListResponse>
Paginated list of evaluation results.
- Defined in client.ts:1373

listSolutionConversations

listSolutionConversations(solutionId: string): Promise<{}[]>
List conversations for a solution.
Parameters
- solutionId: string
  Solution identifier.
Returns Promise<{}[]>
List of conversations.
- Defined in client.ts:2483

listSolutions

listSolutions(opts?: SortableListOptions): Promise<{}>
List solutions.
Parameters
- opts: SortableListOptions = {}
  Pagination and sorting options.
Returns Promise<{}>
Paginated list of solutions.
- Defined in client.ts:2361

listSourceExports

listSourceExports(sourceId: string, opts?: ListOptions): Promise<{}>
List exports for a source.
Parameters
- sourceId: string
  Source connection identifier.
- opts: ListOptions = {}
  Pagination options.
Returns Promise<{}>
Paginated list of exports.
- Defined in client.ts:2171

listSources

listSources(opts?: SortableListOptions & { accountId?: string }): Promise<{}>
List sources.
Parameters
- opts: SortableListOptions & { accountId?: string } = {}
  Pagination, sorting, and filter options.
Returns Promise<{}>
Paginated list of sources.
- Defined in client.ts:2074

markAgentAiSuggestion

markAgentAiSuggestion(
    agentId: string,
    conversationId: string,
    body: {},
): Promise<void>
Mark an AI suggestion as accepted or rejected.
Parameters
- agentId: string
  Agent identifier.
- conversationId: string
  Conversation turn identifier.
- body: {}
  Mark request payload.
Returns Promise<void>
- Defined in client.ts:1524

markAllModelAlertsRead

markAllModelAlertsRead(): Promise<void>
Mark all model alerts as read.

Returns Promise<void>
- Defined in client.ts:2784

markModelAlertRead

markModelAlertRead(alertId: string): Promise<void>
Mark a specific model alert as read.
Parameters
- alertId: string
  Model alert identifier.
Returns Promise<void>
- Defined in client.ts:2800

markSolutionConversationTurn

markSolutionConversationTurn(
    solutionId: string,
    conversationId: string,
    body: {},
): Promise<void>
Mark a conversation turn (e.g. accepted/rejected).
Parameters
- solutionId: string
  Solution identifier.
- conversationId: string
  Conversation identifier.
- body: {}
  Mark payload.
Returns Promise<void>
- Defined in client.ts:2505

paginate

paginate<T>(
    fetchPage: (
        opts: { limit: number; page: number },
    ) => Promise<
        { items: T[]; pagination?: { page: number; total_pages: number } },
    >,
    opts?: { limit?: number },
): AsyncGenerator<T, void, undefined>
Auto-paginate through a list endpoint.

Yields individual items from each page, automatically fetching the next page until all items have been returned.
Type Parameters
- T
Parameters
- fetchPage: (
  opts: { limit: number; page: number },
  ) => Promise<
  { items: T[]; pagination?: { page: number; total_pages: number } },
  >
  A function that fetches a single page given { page, limit }.
- Optionalopts: { limit?: number }
  Page size (default: 50).
Returns AsyncGenerator<T, void, undefined>
Example
```
for await (const agent of client.paginate(
  (opts) => client.listAgents(opts),
)) {
  console.log(agent);
}
```
- Defined in client.ts:3196

previewImportAgent

previewImportAgent(body: {}): Promise<{}>
Validate an agent_definition payload (same shape as exportAgent) without creating or modifying any agent.

Use this before createAgent or updateAgent with an agent_definition to surface unresolved_refs — 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 entity_remap on the commit call to substitute them.
Parameters
- body: {}
  The preview payload ({ agent_definition: ... }).
Returns Promise<{}>
Summary of the validated payload (step counts, schedules, alert configs, evaluation criteria, governance policies, and any unresolved_refs).

Throws
On HTTP 422 — the body is an AgentDefinitionImportErrorResponse with 1-indexed line/column-anchored errors against a canonical source echo.
- Defined in client.ts:932

removeAgentEmailOptOut

removeAgentEmailOptOut(optoutId: string): Promise<void>
Revoke an opt-out, opting the recipient back in to agent emails.
Parameters
- optoutId: string
  Opt-out identifier.
Returns Promise<void>
- Defined in client.ts:1749

removeEmailDomain

removeEmailDomain(domainId: string): Promise<{}>
Remove a domain and tear down its SES identity + DNS / receipt-rule recipient.

Returns a cleanup_note when the removed domain was Seclai-managed (delegated), reminding you to delete the registrar NS delegation record (dangling-delegation / subdomain-takeover guard). Requires an account owner/admin.
Parameters
- domainId: string
  Domain identifier.
Returns Promise<{}>
- Defined in client.ts:3006

replaceContentWithInlineText

replaceContentWithInlineText(contentVersionId: string, body: {}): Promise<{}>
Replace content with inline text.
Parameters
- contentVersionId: string
  Content version identifier.
- body: {}
  Inline text replacement payload.
Returns Promise<{}>
- Defined in client.ts:2302

request

request(
    method: string,
    path: string,
    opts?: {
        headers?: Record<string, string>;
        json?: unknown;
        query?: Record<string, unknown>;
        signal?: AbortSignal;
    },
): Promise<unknown>
Make a raw HTTP request to the Seclai API.

This is a low-level escape hatch. For most operations, prefer the typed convenience methods.
Parameters
- method: string
  HTTP method (e.g. "GET", "POST").
- path: string
  Request path relative to baseUrl (e.g. "/sources/").
- Optionalopts: {
      headers?: Record<string, string>;
      json?: unknown;
      query?: Record<string, unknown>;
      signal?: AbortSignal;
  }
  Query params, JSON body, per-request headers, and optional AbortSignal.
Returns Promise<unknown>
Parsed JSON for JSON responses, raw text for non-JSON responses, or null for empty bodies.

Throws
SeclaiAPIValidationError For validation errors (typically HTTP 422).

Throws
SeclaiAPIStatusError For other non-success HTTP status codes.
- Defined in client.ts:550

requestRaw

requestRaw(
    method: string,
    path: string,
    opts?: {
        headers?: Record<string, string>;
        json?: unknown;
        query?: Record<string, unknown>;
        signal?: AbortSignal;
    },
): Promise<Response>
Make a raw HTTP request and return the raw Response object (for binary downloads, etc.).
Parameters
- method: string
  HTTP method.
- path: string
  Request path relative to baseUrl.
- Optionalopts: {
      headers?: Record<string, string>;
      json?: unknown;
      query?: Record<string, unknown>;
      signal?: AbortSignal;
  }
  Query params, JSON body, per-request headers, and optional AbortSignal.
Returns Promise<Response>
The raw Response object.

Throws
On HTTP 422 responses.

Throws
On other non-2xx responses.
- Defined in client.ts:629

resumeInboundEmail

resumeInboundEmail(): Promise<{}>
Manually lift the account-wide inbound-email pause.

If the queued backlog is still above the ceiling the breaker re-arms on the next evaluation — this is a one-shot override, not a permanent disable. Requires an account owner/admin.

Returns Promise<{}>
- Defined in client.ts:1854

runAgent

runAgent(agentId: string, body: {}): Promise<{}>
Start an agent run.
Parameters
- agentId: string
  Agent identifier.
- body: {}
  Run request payload (input, metadata, priority, etc.).
Returns Promise<{}>
The created agent run.
- Defined in client.ts:972

runAgentAndPoll

runAgentAndPoll(
    agentId: string,
    body: {},
    opts?: {
        includeStepOutputs?: boolean;
        pollIntervalMs?: number;
        signal?: AbortSignal;
        timeoutMs?: number;
    },
): Promise<{}>
Run an agent and poll until it reaches a terminal status.

This is useful in environments where SSE streaming is unavailable.
Parameters
- agentId: string
  Agent identifier.
- body: {}
  Run request payload.
- Optionalopts: {
      includeStepOutputs?: boolean;
      pollIntervalMs?: number;
      signal?: AbortSignal;
      timeoutMs?: number;
  }
  Polling configuration and abort signal.
  - OptionalincludeStepOutputs?: boolean
    Include per-step outputs in the final result.
  - OptionalpollIntervalMs?: number
    Polling interval in ms (default: 2000).
  - Optionalsignal?: AbortSignal
  - OptionaltimeoutMs?: number
    Maximum time to wait in ms (default: 300000 = 5 min).
Returns Promise<{}>
The terminal agent run.

Throws
SeclaiStreamingError On timeout.
- Defined in client.ts:1322

runStreamingAgent

runStreamingAgent(
    agentId: string,
    body: {},
    opts?: { signal?: AbortSignal; timeoutMs?: number },
): AsyncGenerator<AgentRunEvent, void, undefined>
Run an agent in streaming mode and yield each SSE event as it arrives.

This is an AsyncGenerator suitable for real-time UIs that want to render step progress as it happens.
Parameters
- agentId: string
  Agent identifier.
- body: {}
  Streaming run request payload.
- Optionalopts: { signal?: AbortSignal; timeoutMs?: number }
  Timeout and abort signal options.
Returns AsyncGenerator<AgentRunEvent, void, undefined>
Yields
AgentRunEvent for each SSE message.
Example
```
for await (const event of client.runStreamingAgent("agent-id", { input: "Hello!" })) {
  if (event.event === "done") {
    console.log("Final:", event.data);
  }
}
```
- Defined in client.ts:1194

runStreamingAgentAndWait

runStreamingAgentAndWait(
    agentId: string,
    body: {},
    opts?: { signal?: AbortSignal; timeoutMs?: number },
): Promise<{}>
Run an agent in streaming mode (SSE) and wait for the final result.

Consumes the entire SSE stream and returns only the terminal done payload. For real-time event access, use runStreamingAgent instead.
Parameters
- agentId: string
  Agent identifier.
- body: {}
  Streaming run request payload.
- Optionalopts: { signal?: AbortSignal; timeoutMs?: number }
  Timeout and abort signal options.
Returns Promise<{}>
Final agent run payload from the done event.

Throws
SeclaiStreamingError If the stream ends before a done event.
- Defined in client.ts:1061

search

search(
opts: { entityType?: string; limit?: number; query: string },
): Promise<{}>
Search across all resource types in your account.

Accepts a free-text keyword query or a UUID. Results are ranked: name-prefix > name-substring > description-substring.
Parameters
- opts: { entityType?: string; limit?: number; query: string }
  Search options.
  - OptionalentityType?: string
    Optional entity type filter (e.g. "agent", "knowledge_base").
  - Optionallimit?: number
    Maximum results (1-50, default 10).
  - query: string
    Search query string (required, 1-200 chars).
Returns Promise<{}>
Search results.
- Defined in client.ts:2932

searchAgentRuns

searchAgentRuns(body: {}): Promise<{}>
Search agent runs (traces) across all agents.
Parameters
- body: {}
  Search query and filters.
Returns Promise<{}>
Search results with matching runs.
- Defined in client.ts:998

searchDocs

searchDocs(
opts: { limit?: number; mode?: "keyword" | "semantic"; query: string },
): Promise<Record<string, unknown>>
Search the Seclai documentation by content.

mode: "keyword" matches page titles and summaries (fast, no AI cost); mode: "semantic" matches page body content by meaning (uses an embedding).

Each result carries a doc_slug and an optional section anchor for building a https://seclai.com/docs/<doc_slug>[#<anchor>] link, a score (not comparable across modes), and — in semantic mode — a highlight (best matching verbatim sentence; null for keyword).

Documentation is global, so results are not account-scoped.
Parameters
- opts: { limit?: number; mode?: "keyword" | "semantic"; query: string }
  Search options.
  - Optionallimit?: number
    Maximum results (1-20, default 8).
  - Optionalmode?: "keyword" | "semantic"
    Search strategy (default "keyword").
  - query: string
    Search query string (required, 1-200 chars).
Returns Promise<Record<string, unknown>>
- Defined in client.ts:2956

sendEmailDomainTestEmail

sendEmailDomainTestEmail(domainId: string): Promise<{}>
Send a test message FROM a verified domain (noreply@<domain>) TO the account owner's email.

Confirms end-to-end that the domain actually sends (SES verified, DKIM/SPF aligned). Never sends to any other address, so it can't be used as an open relay. Requires an account owner/admin.
Parameters
- domainId: string
  Domain identifier.
Returns Promise<{}>
- Defined in client.ts:3059

setAutoBlockMode

setAutoBlockMode(body: {}): Promise<{}>
Set whether a governance BLOCK on an authenticated inbound sender auto-adds them to the blocklist.

mode is "disabled", "input", or "input_and_output". Requires an account owner/admin.
Parameters
- body: {}
  The mode to set.
Returns Promise<{}>
The updated blocked-sender list.
- Defined in client.ts:1803

setEmailTriggerConfig

setEmailTriggerConfig(agentId: string, triggerId: string, body: {}): Promise<{}>
Configure an agent's EMAIL_RECEIVED trigger and return its computed email address(es).

Sets the custom alias, the sender allowlist, and the inbound-handling flags (ignore_auto_generated, require_sender_auth, queue_on_quota). Omitted fields are left unchanged; passing null (or "" for alias) clears them.
Parameters
- agentId: string
  Agent identifier.
- triggerId: string
  Trigger identifier.
- body: {}
  The fields to set.
Returns Promise<{}>
The trigger's resolved addresses and config.
- Defined in client.ts:1713

setPrimaryEmailDomain

setPrimaryEmailDomain(domainId: string): Promise<{}>
Promote a verified domain to the account's primary domain.

Agent email then sends FROM and receives ON this domain (<agentID>@<domain>, <alias>@<domain>) instead of the shared agent.seclai.com. The domain must be verified. Requires an account owner/admin.
Parameters
- domainId: string
  Domain identifier.
Returns Promise<{}>
- Defined in client.ts:3034

startSourceEmbeddingMigration

startSourceEmbeddingMigration(sourceId: string, body: {}): Promise<{}>
Start a source embedding migration.
Parameters
- sourceId: string
  Source connection identifier.
- body: {}
  Migration configuration (target embedding model, etc.).
Returns Promise<{}>
Migration status.
- Defined in client.ts:2262

submitAiFeedback

submitAiFeedback(body: {}): Promise<{}>
Submit feedback on an AI assistant interaction.
Parameters
- body: {}
  Feedback payload (thumbs up/down, optional comment).
Returns Promise<{}>
Feedback response.
- Defined in client.ts:3098

subscribeToAlert

subscribeToAlert(alertId: string): Promise<{}>
Subscribe to an alert.
Parameters
- alertId: string
  Alert identifier.
Returns Promise<{}>
- Defined in client.ts:2661

testCompactionPromptStandalone

testCompactionPromptStandalone(body: {}): Promise<{}>
Test compaction prompt standalone (not tied to a specific memory bank).
Parameters
- body: {}
  Standalone compaction test request.
Returns Promise<{}>
- Defined in client.ts:2024

testDraftEvaluation

testDraftEvaluation(agentId: string, body: {}): Promise<{}>
Test a draft evaluation criteria without persisting it.
Parameters
- agentId: string
  Agent identifier.
- body: {}
  Draft evaluation to test.
Returns Promise<{}>
Test evaluation response.
- Defined in client.ts:1657

testMemoryBankCompaction

testMemoryBankCompaction(memoryBankId: string, body: {}): Promise<{}>
Test compaction for a specific memory bank.
Parameters
- memoryBankId: string
  Memory bank identifier.
- body: {}
  Test compaction request.
Returns Promise<{}>
- Defined in client.ts:2015

unblockEmailSender

unblockEmailSender(blockedId: string): Promise<void>
Remove a blocked sender by id. Requires an account owner/admin.
Parameters
- blockedId: string
  Blocked-sender identifier.
Returns Promise<void>
- Defined in client.ts:1789

unlinkAgentsFromSolution

unlinkAgentsFromSolution(solutionId: string, body: {}): Promise<{}>
Unlink agents from a solution.
Parameters
- solutionId: string
  Solution identifier.
- body: {}
  Resource IDs to unlink.
Returns Promise<{}>
Updated solution.
- Defined in client.ts:2427

unlinkKnowledgeBasesFromSolution

unlinkKnowledgeBasesFromSolution(solutionId: string, body: {}): Promise<{}>
Unlink knowledge bases from a solution.
Parameters
- solutionId: string
  Solution identifier.
- body: {}
  Resource IDs to unlink.
Returns Promise<{}>
Updated solution.
- Defined in client.ts:2449

unlinkSourceConnectionsFromSolution

unlinkSourceConnectionsFromSolution(solutionId: string, body: {}): Promise<{}>
Unlink source connections from a solution.
Parameters
- solutionId: string
  Solution identifier.
- body: {}
  Resource IDs to unlink.
Returns Promise<{}>
Updated solution.
- Defined in client.ts:2471

unsubscribeFromAlert

unsubscribeFromAlert(alertId: string): Promise<{}>
Unsubscribe from an alert.
Parameters
- alertId: string
  Alert identifier.
Returns Promise<{}>
- Defined in client.ts:2670

updateAgent

updateAgent(agentId: string, body: {}): Promise<{}>
Update an agent.
Parameters
- agentId: string
  Agent identifier.
- body: {}
  Fields to update.
Returns Promise<{}>
Updated agent summary.
- Defined in client.ts:838

updateAgentDefinition

updateAgentDefinition(agentId: string, body: {}): Promise<{}>
Update an agent's definition.
Parameters
- agentId: string
  Agent identifier.
- body: {}
  Updated definition payload.
Returns Promise<{}>
Updated agent definition.
- Defined in client.ts:957

updateAlertConfig

updateAlertConfig(configId: string, body: {}): Promise<{}>
Update an alert configuration.
Parameters
- configId: string
  Alert config identifier.
- body: {}
  Fields to update.
Returns Promise<{}>
Updated alert config.
- Defined in client.ts:2721

updateApiVersion

updateApiVersion(version: null | string): Promise<{}>
Pin the account to a dated API version, or clear the pin.

Owner/admin only. The pin applies to later header-less requests; a Seclai-Version header still overrides it, so effective_version in the response describes this request rather than the pin just written.
Parameters
- version: null | string
  A YYYY-MM-DD date to pin to, or null to clear the pin.
Returns Promise<{}>
The updated version state.
- Defined in client.ts:791

updateEvaluationCriteria

updateEvaluationCriteria(criteriaId: string, body: {}): Promise<{}>
Update an evaluation criteria.
Parameters
- criteriaId: string
  Criteria identifier.
- body: {}
  Fields to update.
Returns Promise<{}>
Updated evaluation criteria.
- Defined in client.ts:1592

updateKnowledgeBase

updateKnowledgeBase(knowledgeBaseId: string, body: {}): Promise<{}>
Update a knowledge base.
Parameters
- knowledgeBaseId: string
  Knowledge base identifier.
- body: {}
  Fields to update.
Returns Promise<{}>
Updated knowledge base.
- Defined in client.ts:1901

updateMemoryBank

updateMemoryBank(memoryBankId: string, body: {}): Promise<{}>
Update a memory bank.
Parameters
- memoryBankId: string
  Memory bank identifier.
- body: {}
  Fields to update.
Returns Promise<{}>
Updated memory bank.
- Defined in client.ts:1960

updateOrganizationAlertPreference

updateOrganizationAlertPreference(
    organizationId: string,
    alertType: string,
    body: {},
): Promise<{}>
Update an organization alert preference.
Parameters
- organizationId: string
  Organization identifier.
- alertType: string
  Alert type.
- body: {}
  Preference update.
Returns Promise<{}>
- Defined in client.ts:2750

updateSolution

updateSolution(solutionId: string, body: {}): Promise<{}>
Update a solution.
Parameters
- solutionId: string
  Solution identifier.
- body: {}
  Fields to update.
Returns Promise<{}>
Updated solution.
- Defined in client.ts:2394

updateSource

updateSource(sourceId: string, body: {}): Promise<{}>
Update a source.
Parameters
- sourceId: string
  Source connection identifier.
- body: {}
  Fields to update.
Returns Promise<{}>
Updated source.
- Defined in client.ts:2115

uploadAgentInput

uploadAgentInput(
    agentId: string,
    opts: {
        file: Blob | Uint8Array<ArrayBufferLike> | BufferSource;
        fileName?: string;
        mimeType?: string;
    },
): Promise<{}>
Upload a file to use as input for a dynamic_input agent run.

After uploading, poll getAgentInputUploadStatus until status is ready, then pass input_upload_id to runAgent.
Parameters
- agentId: string
  Agent identifier.
- opts: {
      file: Blob | Uint8Array<ArrayBufferLike> | BufferSource;
      fileName?: string;
      mimeType?: string;
  }
  File payload and optional metadata.
Returns Promise<{}>
Upload response with the upload ID and status.
- Defined in client.ts:1402

uploadFileToContent

uploadFileToContent(
    contentVersionId: string,
    opts: {
        file: Blob | Uint8Array<ArrayBufferLike> | BufferSource;
        fileName?: string;
        metadata?: Record<string, unknown>;
        mimeType?: string;
        title?: string;
    },
): Promise<{}>
Upload a file to replace content for an existing content version.
Parameters
- contentVersionId: string
  Content version identifier.
- opts: {
      file: Blob | Uint8Array<ArrayBufferLike> | BufferSource;
      fileName?: string;
      metadata?: Record<string, unknown>;
      mimeType?: string;
      title?: string;
  }
  File payload and optional metadata.
Returns Promise<{}>
Upload response.
- Defined in client.ts:2338

uploadFileToSource

uploadFileToSource(
    sourceId: string,
    opts: {
        file: Blob | Uint8Array<ArrayBufferLike> | BufferSource;
        fileName?: string;
        metadata?: Record<string, unknown>;
        mimeType?: string;
        title?: string;
    },
): Promise<{}>
Upload a file to a source.

Maximum file size: 200 MiB. Supports text, PDF, DOCX, audio, video, images, and more. If mimeType is omitted, it will be inferred from the fileName extension when possible.
Parameters
- sourceId: string
  Source connection identifier.
- opts: {
      file: Blob | Uint8Array<ArrayBufferLike> | BufferSource;
      fileName?: string;
      metadata?: Record<string, unknown>;
      mimeType?: string;
      title?: string;
  }
  File payload and optional metadata.
Returns Promise<{}>
Upload response details.
- Defined in client.ts:2138

uploadInlineTextToSource

uploadInlineTextToSource(sourceId: string, body: {}): Promise<{}>
Upload inline text to a source.
Parameters
- sourceId: string
  Source connection identifier.
- body: {}
  Inline text upload payload.
Returns Promise<{}>
Upload response.
- Defined in client.ts:2158

useSharedEmailDomain

useSharedEmailDomain(): Promise<void>
Revert to the shared agent.seclai.com sending/inbound domain.

Clears the account's primary domain WITHOUT removing the configured domain(s) — they stay verified and can be promoted again later. Requires an account owner/admin.

Returns Promise<void>
- Defined in client.ts:3045

verifyEmailDomain

verifyEmailDomain(domainId: string): Promise<{}>
Run a verification check immediately ("Check now").

Re-polls SES + DNS for this domain instead of waiting for the background verification sweep, and returns its updated status + DNS-record check results. Useful right after publishing the required records. Requires an account owner/admin.
Parameters
- domainId: string
  Domain identifier.
Returns Promise<{}>
- Defined in client.ts:3020

Class Seclai

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Seclai

Throws

Throws

Methods

acceptAiAssistantPlan

Parameters

Returns Promise<{}>

acceptAiMemoryBankSuggestion

Parameters

Returns Promise<{}>

acceptGovernanceAiPlan

Parameters

Returns Promise<{}>

acceptMemoryBankAiSuggestion

Parameters

Returns Promise<{}>

acceptSolutionAiPlan

Parameters

Returns Promise<{}>

addAlertComment

Parameters

Returns Promise<{}>

addEmailDomain

Parameters

Returns Promise<{}>

addSolutionConversationTurn

Parameters

Returns Promise<{}>

aiAssistantKnowledgeBase

Parameters

Returns Promise<{}>

aiAssistantMemoryBank

Parameters

Returns Promise<{}>

aiAssistantSolution

Parameters

Returns Promise<{}>

aiAssistantSource

Parameters

Returns Promise<{}>

blockEmailSender

Parameters

Returns Promise<{}>

cancelAgentRun

Parameters

Returns Promise<{}>

cancelExperiment

Parameters

Returns Promise<{}>

cancelQueuedEmailRuns

Returns Promise<{}>

cancelSourceEmbeddingMigration

Parameters

Returns Promise<{}>

cancelSourceExport

Parameters

Returns Promise<{}>

changeAlertStatus

Parameters

Returns Promise<{}>

compactMemoryBank

Parameters

Returns Promise<void>

createAgent

Parameters

Returns Promise<{}>

createAlertConfig

Parameters

Returns Promise<{}>

createEvaluationCriteria

Parameters

Returns Promise<{}>