Class Seclai

Seclai JavaScript/TypeScript client.

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

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);
}

Constructors

Methods

acceptAiAssistantPlan acceptAiMemoryBankSuggestion acceptGovernanceAiPlan acceptMemoryBankAiSuggestion acceptSolutionAiPlan addAlertComment addSolutionConversationTurn aiAssistantKnowledgeBase aiAssistantMemoryBank aiAssistantSolution aiAssistantSource cancelAgentRun cancelSourceEmbeddingMigration cancelSourceExport changeAlertStatus compactMemoryBank createAgent createAlertConfig createEvaluationCriteria createEvaluationResult createKnowledgeBase createMemoryBank createSolution createSource createSourceExport declineAiAssistantPlan declineGovernanceAiPlan declineSolutionAiPlan deleteAgent deleteAgentRun deleteAlertConfig deleteContent deleteEvaluationCriteria deleteKnowledgeBase deleteMemoryBank deleteMemoryBankSource deleteSolution deleteSource deleteSourceExport downloadSourceExport estimateSourceExport generateAgentSteps generateGovernanceAiPlan generateMemoryBankConfig generateSolutionAiKnowledgeBase generateSolutionAiPlan generateSolutionAiSource generateStepConfig getAgent getAgentAiConversationHistory getAgentDefinition getAgentInputUploadStatus getAgentRun getAgentsUsingMemoryBank getAiAssistantMemoryBankHistory getAlert getAlertConfig getContentDetail getEvaluationCriteria getEvaluationCriteriaSummary getKnowledgeBase getMemoryBank getMemoryBankAiLastConversation getMemoryBankStats getModelRecommendations getNonManualEvaluationSummary getSolution getSource getSourceEmbeddingMigration getSourceExport getUnreadModelAlertCount linkAgentsToSolution linkKnowledgeBasesToSolution linkSourceConnectionsToSolution listAgentEvaluationResults listAgentRuns listAgents listAlertConfigs listAlerts listCompatibleRuns listContentEmbeddings listEvaluationCriteria listEvaluationResults listEvaluationRuns listGovernanceAiConversations listKnowledgeBases listMemoryBanks listMemoryBankTemplates listModelAlerts listOrganizationAlertPreferences listRunEvaluationResults listSolutionConversations listSolutions listSourceExports listSources markAgentAiSuggestion markAllModelAlertsRead markModelAlertRead markSolutionConversationTurn paginate replaceContentWithInlineText request requestRaw runAgent runAgentAndPoll runStreamingAgent runStreamingAgentAndWait search searchAgentRuns startSourceEmbeddingMigration submitAiFeedback subscribeToAlert testCompactionPromptStandalone testDraftEvaluation testMemoryBankCompaction unlinkAgentsFromSolution unlinkKnowledgeBasesFromSolution unlinkSourceConnectionsFromSolution unsubscribeFromAlert updateAgent updateAgentDefinition updateAlertConfig updateEvaluationCriteria updateKnowledgeBase updateMemoryBank updateOrganizationAlertPreference updateSolution updateSource uploadAgentInput uploadFileToContent uploadFileToSource uploadInlineTextToSource

Constructors

  • 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

    Returns Seclai

    SeclaiConfigurationError If no fetch implementation is available.

    SeclaiConfigurationError If both apiKey and accessToken are provided.

Methods

  • Accept an AI assistant suggestion.

    Parameters

    • conversationId: string

      Conversation identifier.

    • body: {}

      Acceptance request payload.

    Returns Promise<{}>

  • Accept/mark an AI memory bank suggestion.

    Parameters

    • conversationId: string

      Conversation identifier.

    • body: {}

      Acceptance payload for the memory bank suggestion.

    Returns Promise<unknown>

  • Accept a governance AI plan.

    Parameters

    • conversationId: string

      Conversation identifier.

    Returns Promise<{}>

    Acceptance result.

  • Accept a memory bank AI suggestion.

    Parameters

    • conversationId: string

      Conversation identifier.

    • body: {}

      Accept request payload.

    Returns Promise<unknown>

  • Accept a solution AI plan.

    Parameters

    • solutionId: string

      Solution identifier.

    • conversationId: string

      Conversation identifier.

    • body: {}

      Accept request.

    Returns Promise<{}>

    Acceptance result with executed actions.

  • Add a comment to an alert.

    Parameters

    • alertId: string

      Alert identifier.

    • body: {}

      Comment payload.

    Returns Promise<unknown>

  • Add a conversation turn to a solution.

    Parameters

    • solutionId: string

      Solution identifier.

    • body: {}

      Conversation turn payload.

    Returns Promise<{}>

    Updated conversation.

  • Generate a knowledge base configuration via AI assistant.

    Parameters

    • body: {}

      Generation request.

    Returns Promise<{}>

  • Generate a memory bank configuration via AI assistant.

    Parameters

    • body: {}

      Generation request.

    Returns Promise<{}>

  • Generate a solution via AI assistant.

    Parameters

    • body: {}

      Generation request.

    Returns Promise<{}>

  • Generate a source configuration via AI assistant.

    Parameters

    • body: {}

      Generation request.

    Returns Promise<{}>

  • Cancel a running agent run.

    Parameters

    • runId: string

      Run identifier.

    Returns Promise<{}>

    Updated run (with cancelled status).

  • Cancel a source embedding migration.

    Parameters

    • sourceId: string

      Source connection identifier.

    Returns Promise<{}>

    Updated migration status.

  • Cancel a source export.

    Parameters

    • sourceId: string

      Source connection identifier.

    • exportId: string

      Export identifier.

    Returns Promise<{}>

  • Change the status of an alert.

    Parameters

    • alertId: string

      Alert identifier.

    • body: {}

      Status change request.

    Returns Promise<unknown>

  • Compact a memory bank (trigger compaction).

    Parameters

    • memoryBankId: string

      Memory bank identifier.

    Returns Promise<void>

  • Create a new agent.

    Parameters

    • body: {}

      Agent creation payload (name, trigger type, template, etc.).

    Returns Promise<{}>

    Summary of the created agent.

  • Create an alert configuration.

    Parameters

    • body: {}

      Alert config definition.

    Returns Promise<unknown>

    Created alert config.

  • Create evaluation criteria for an agent.

    Parameters

    • agentId: string

      Agent identifier.

    • body: {}

      Criteria definition.

    Returns Promise<{}>

    Created evaluation criteria.

  • Create a manual evaluation result for a criteria.

    Parameters

    • criteriaId: string

      Criteria identifier.

    • body: {}

      Evaluation result payload.

    Returns Promise<{}>

    Created evaluation result.

  • Create a new knowledge base.

    Parameters

    • body: {}

      Knowledge base configuration.

    Returns Promise<{}>

    The created knowledge base.

  • 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.

  • Create a new solution.

    Parameters

    • body: {}

      Solution configuration.

    Returns Promise<{}>

    The created solution.

  • Create a new content source.

    Parameters

    • body: {}

      Source configuration (type, name, knowledge base link, etc.).

    Returns Promise<{}>

    The created source.

  • Create a source data export.

    Parameters

    • sourceId: string

      Source connection identifier.

    • body: {}

      Export configuration (format, etc.).

    Returns Promise<{}>

    Export response with job status.

  • Decline an AI assistant suggestion.

    Parameters

    • conversationId: string

      Conversation identifier.

    Returns Promise<void>

  • Decline a governance AI plan.

    Parameters

    • conversationId: string

      Conversation identifier.

    Returns Promise<void>

  • Decline a solution AI plan.

    Parameters

    • solutionId: string

      Solution identifier.

    • conversationId: string

      Conversation identifier.

    Returns Promise<void>

  • Delete an agent.

    Parameters

    • agentId: string

      Agent identifier.

    Returns Promise<void>

  • Delete an agent run.

    Parameters

    • runId: string

      Run identifier.

    Returns Promise<void>

  • Delete an alert configuration.

    Parameters

    • configId: string

      Alert config identifier.

    Returns Promise<void>

  • Delete a specific content version.

    Parameters

    • contentVersionId: string

      Content version identifier.

    Returns Promise<void>

  • Delete an evaluation criteria and all associated results.

    Parameters

    • criteriaId: string

      Criteria identifier.

    Returns Promise<void>

  • Delete a knowledge base.

    Parameters

    • knowledgeBaseId: string

      Knowledge base identifier.

    Returns Promise<void>

  • Delete a memory bank.

    Parameters

    • memoryBankId: string

      Memory bank identifier.

    Returns Promise<void>

  • Delete a memory bank source.

    Parameters

    • memoryBankId: string

      Memory bank identifier.

    Returns Promise<void>

  • Delete a solution.

    Parameters

    • solutionId: string

      Solution identifier.

    Returns Promise<void>

  • Delete a source.

    Parameters

    • sourceId: string

      Source connection identifier.

    Returns Promise<void>

  • Delete a source export.

    Parameters

    • sourceId: string

      Source connection identifier.

    • exportId: string

      Export identifier.

    Returns Promise<void>

  • 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.

  • Estimate a source export.

    Parameters

    • sourceId: string

      Source connection identifier.

    • body: {}

      Estimate request.

    Returns Promise<{}>

    Export estimate.

  • 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.

  • Generate governance policy suggestions using AI.

    Parameters

    • body: {}

      AI governance request.

    Returns Promise<{}>

    AI-generated governance suggestions.

  • Generate memory bank configuration using AI.

    Parameters

    • body: {}

      AI assistant request with user instructions.

    Returns Promise<{}>

    AI-generated memory bank config.

  • Generate a knowledge base configuration via solution AI.

    Parameters

    • solutionId: string

      Solution identifier.

    • body: {}

      Generation request.

    Returns Promise<{}>

    AI-generated knowledge base config.

  • Generate a solution AI plan.

    Parameters

    • solutionId: string

      Solution identifier.

    • body: {}

      Generation request.

    Returns Promise<{}>

    AI-generated plan.

  • Generate a source configuration via solution AI.

    Parameters

    • solutionId: string

      Solution identifier.

    • body: {}

      Generation request.

    Returns Promise<{}>

    AI-generated source config.

  • Generate a single step configuration using AI.

    Parameters

    • agentId: string

      Agent identifier.

    • body: {}

      Step config generation request.

    Returns Promise<{}>

    AI-generated step config.

  • Get agent details including its definition.

    Parameters

    • agentId: string

      Agent identifier.

    Returns Promise<{}>

    Full agent metadata.

  • Get AI conversation history for an agent.

    Parameters

    • agentId: string

      Agent identifier.

    Returns Promise<{}>

    Conversation history.

  • Get an agent's full definition (steps, model config, etc.).

    Parameters

    • agentId: string

      Agent identifier.

    Returns Promise<{}>

    The agent definition.

  • Get the status of an agent input upload.

    Parameters

    • agentId: string

      Agent identifier.

    • uploadId: string

      Upload identifier.

    Returns Promise<{}>

    Upload status and metadata.

  • Get details of a specific agent run.

    Parameters

    • runId: string

      Run identifier.

    • Optionalopts: { includeStepOutputs?: boolean }

      Optional flags.

    Returns Promise<{}>

    Agent run details.

  • Get agents that are using a specific memory bank.

    Parameters

    • memoryBankId: string

      Memory bank identifier.

    Returns Promise<unknown>

  • Get AI assistant memory bank conversation history.

    Returns Promise<{}>

  • Get alert details by ID.

    Parameters

    • alertId: string

      Alert identifier.

    Returns Promise<unknown>

    Alert details.

  • Get an alert configuration by ID.

    Parameters

    • configId: string

      Alert config identifier.

    Returns Promise<unknown>

    Alert config details.

  • 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.

  • Get a single evaluation criteria by ID.

    Parameters

    • criteriaId: string

      Criteria identifier.

    Returns Promise<{}>

    Evaluation criteria details.

  • Get the evaluation summary for a specific criteria.

    Parameters

    • criteriaId: string

      Criteria identifier.

    Returns Promise<{}>

    Evaluation result summary.

  • Get a knowledge base by ID.

    Parameters

    • knowledgeBaseId: string

      Knowledge base identifier.

    Returns Promise<{}>

    Knowledge base details.

  • Get a memory bank by ID.

    Parameters

    • memoryBankId: string

      Memory bank identifier.

    Returns Promise<{}>

    Memory bank details.

  • Get the last AI conversation for memory banks.

    Returns Promise<{}>

  • Get stats for a memory bank.

    Parameters

    • memoryBankId: string

      Memory bank identifier.

    Returns Promise<unknown>

  • Get model recommendations.

    Parameters

    • modelId: string

      Model identifier.

    Returns Promise<unknown>

  • Get a summary of non-manual evaluations across an agent's runs.

    Parameters

    • agentId: string

      Agent identifier.

    Returns Promise<{}>

  • Get a solution by ID.

    Parameters

    • solutionId: string

      Solution identifier.

    Returns Promise<{}>

    Solution details.

  • Get a source by ID.

    Parameters

    • sourceId: string

      Source connection identifier.

    Returns Promise<{}>

    Source details.

  • Get the status of a source embedding migration.

    Parameters

    • sourceId: string

      Source connection identifier.

    Returns Promise<{}>

    Migration status.

  • Get a specific source export.

    Parameters

    • sourceId: string

      Source connection identifier.

    • exportId: string

      Export identifier.

    Returns Promise<{}>

    Export details.

  • Get unread model alert count.

    Returns Promise<unknown>

  • Link agents to a solution.

    Parameters

    • solutionId: string

      Solution identifier.

    • body: {}

      Resource IDs to link.

    Returns Promise<{}>

    Updated solution.

  • Link knowledge bases to a solution.

    Parameters

    • solutionId: string

      Solution identifier.

    • body: {}

      Resource IDs to link.

    Returns Promise<{}>

    Updated solution.

  • Link source connections to a solution.

    Parameters

    • solutionId: string

      Solution identifier.

    • body: {}

      Resource IDs to link.

    Returns Promise<{}>

    Updated solution.

  • List all evaluation results for an agent.

    Parameters

    • agentId: string

      Agent identifier.

    • opts: ListOptions = {}

      Pagination options.

    Returns 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.

  • List agents.

    Parameters

    Returns Promise<{}>

    Paginated list of agents.

  • List alert configurations.

    Parameters

    Returns Promise<unknown>

    Paginated list of alert configs.

  • List alerts.

    Parameters

    • opts: ListOptions & { severity?: string; status?: string } = {}

      Pagination and filter options.

    Returns Promise<unknown>

    Paginated list of alerts.

  • List runs compatible with a specific evaluation criteria.

    Parameters

    • criteriaId: string

      Criteria identifier.

    • opts: ListOptions = {}

      Pagination options.

    Returns Promise<{}>

  • List embeddings for a content version.

    Parameters

    • contentVersionId: string

      Content version identifier.

    • opts: ListOptions = {}

      Pagination options.

    Returns Promise<{}>

    Paginated list of embeddings.

  • List evaluation criteria for an agent.

    Parameters

    • agentId: string

      Agent identifier.

    • opts: ListOptions = {}

      Pagination options.

    Returns Promise<{}[]>

  • List evaluation results for a specific criteria.

    Parameters

    • criteriaId: string

      Criteria identifier.

    • opts: ListOptions = {}

      Pagination options.

    Returns Promise<{}>

  • List evaluation run summaries for an agent.

    Parameters

    • agentId: string

      Agent identifier.

    • opts: ListOptions = {}

      Pagination options.

    Returns Promise<{}>

  • List governance AI conversations.

    Returns Promise<{}[]>

  • List available memory bank templates.

    Returns Promise<unknown>

  • List organization alert preferences.

    Returns Promise<{}>

  • List evaluation results for a specific agent run.

    Parameters

    • agentId: string

      Agent identifier.

    • runId: string

      Run identifier.

    • opts: ListOptions = {}

      Pagination options.

    Returns Promise<{}>

    Paginated list of evaluation results.

  • List conversations for a solution.

    Parameters

    • solutionId: string

      Solution identifier.

    Returns Promise<{}[]>

    List of conversations.

  • List exports for a source.

    Parameters

    • sourceId: string

      Source connection identifier.

    • opts: ListOptions = {}

      Pagination options.

    Returns Promise<{}>

    Paginated list of exports.

  • List sources.

    Parameters

    • opts: SortableListOptions & { accountId?: string } = {}

      Pagination, sorting, and filter options.

    Returns Promise<{}>

    Paginated list of sources.

  • 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>

  • Mark all model alerts as read.

    Returns Promise<void>

  • Mark a specific model alert as read.

    Parameters

    • alertId: string

      Model alert identifier.

    Returns 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>

  • 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>

    for await (const agent of client.paginate(
    (opts) => client.listAgents(opts),
    )) {
    console.log(agent);
    }
  • Replace content with inline text.

    Parameters

    • contentVersionId: string

      Content version identifier.

    • body: {}

      Inline text replacement payload.

    Returns Promise<{}>

  • 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.

    SeclaiAPIValidationError For validation errors (typically HTTP 422).

    SeclaiAPIStatusError For other non-success HTTP status codes.

  • 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.

    On HTTP 422 responses.

    On other non-2xx responses.

  • Start an agent run.

    Parameters

    • agentId: string

      Agent identifier.

    • body: {}

      Run request payload (input, metadata, priority, etc.).

    Returns Promise<{}>

    The created agent run.

  • 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.

    SeclaiStreamingError On timeout.

  • 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>

    AgentRunEvent for each SSE message.

    for await (const event of client.runStreamingAgent("agent-id", { input: "Hello!" })) {
    if (event.event === "done") {
    console.log("Final:", event.data);
    }
    }
  • 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.

    SeclaiStreamingError If the stream ends before a done event.

  • 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<unknown>

    Search results.

  • Search agent runs (traces) across all agents.

    Parameters

    • body: {}

      Search query and filters.

    Returns Promise<{}>

    Search results with matching runs.

  • Start a source embedding migration.

    Parameters

    • sourceId: string

      Source connection identifier.

    • body: {}

      Migration configuration (target embedding model, etc.).

    Returns Promise<{}>

    Migration status.

  • Submit feedback on an AI assistant interaction.

    Parameters

    • body: {}

      Feedback payload (thumbs up/down, optional comment).

    Returns Promise<{}>

    Feedback response.

  • Subscribe to an alert.

    Parameters

    • alertId: string

      Alert identifier.

    Returns Promise<unknown>

  • Test compaction prompt standalone (not tied to a specific memory bank).

    Parameters

    • body: {}

      Standalone compaction test request.

    Returns Promise<{}>

  • Test a draft evaluation criteria without persisting it.

    Parameters

    • agentId: string

      Agent identifier.

    • body: {}

      Draft evaluation to test.

    Returns Promise<{}>

    Test evaluation response.

  • Test compaction for a specific memory bank.

    Parameters

    • memoryBankId: string

      Memory bank identifier.

    • body: {}

      Test compaction request.

    Returns Promise<{}>

  • Unlink agents from a solution.

    Parameters

    • solutionId: string

      Solution identifier.

    • body: {}

      Resource IDs to unlink.

    Returns Promise<{}>

    Updated solution.

  • Unlink knowledge bases from a solution.

    Parameters

    • solutionId: string

      Solution identifier.

    • body: {}

      Resource IDs to unlink.

    Returns Promise<{}>

    Updated solution.

  • Unlink source connections from a solution.

    Parameters

    • solutionId: string

      Solution identifier.

    • body: {}

      Resource IDs to unlink.

    Returns Promise<{}>

    Updated solution.

  • Unsubscribe from an alert.

    Parameters

    • alertId: string

      Alert identifier.

    Returns Promise<unknown>

  • Update an agent.

    Parameters

    • agentId: string

      Agent identifier.

    • body: {}

      Fields to update.

    Returns Promise<{}>

    Updated agent summary.

  • Update an agent's definition.

    Parameters

    • agentId: string

      Agent identifier.

    • body: {}

      Updated definition payload.

    Returns Promise<{}>

    Updated agent definition.

  • Update an alert configuration.

    Parameters

    • configId: string

      Alert config identifier.

    • body: {}

      Fields to update.

    Returns Promise<unknown>

    Updated alert config.

  • Update an evaluation criteria.

    Parameters

    • criteriaId: string

      Criteria identifier.

    • body: {}

      Fields to update.

    Returns Promise<{}>

    Updated evaluation criteria.

  • Update a knowledge base.

    Parameters

    • knowledgeBaseId: string

      Knowledge base identifier.

    • body: {}

      Fields to update.

    Returns Promise<{}>

    Updated knowledge base.

  • Update a memory bank.

    Parameters

    • memoryBankId: string

      Memory bank identifier.

    • body: {}

      Fields to update.

    Returns Promise<{}>

    Updated memory bank.

  • Update an organization alert preference.

    Parameters

    • organizationId: string

      Organization identifier.

    • alertType: string

      Alert type.

    • body: {}

      Preference update.

    Returns Promise<unknown>

  • Update a solution.

    Parameters

    • solutionId: string

      Solution identifier.

    • body: {}

      Fields to update.

    Returns Promise<{}>

    Updated solution.

  • Update a source.

    Parameters

    • sourceId: string

      Source connection identifier.

    • body: {}

      Fields to update.

    Returns Promise<{}>

    Updated source.

  • 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.

  • 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.

  • 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.

  • Upload inline text to a source.

    Parameters

    • sourceId: string

      Source connection identifier.

    • body: {}

      Inline text upload payload.

    Returns Promise<{}>

    Upload response.