@seclai/sdk 0.0.0

package/dist/index.d.ts

@@ -0,0 +1,708 @@
+interface components {
+    schemas: {
+        /** AgentRunAttemptResponse */
+        AgentRunAttemptResponse: {
+            /**
+             * Duration
+             * @description Duration of the attempt in seconds.
+             */
+            duration: number | null;
+            /**
+             * Ended At
+             * @description Timestamp when the attempt ended.
+             */
+            ended_at: string | null;
+            /**
+             * Error
+             * @description Error message if the attempt failed.
+             */
+            error: string | null;
+            /**
+             * Started At
+             * @description Timestamp when the attempt started.
+             */
+            started_at: string | null;
+            /** @description Status of the agent run attempt. */
+            status: components["schemas"]["PendingProcessingCompletedFailedStatus"];
+        };
+        /** AgentRunRequest */
+        AgentRunRequest: {
+            /**
+             * Input
+             * @description Input to provide to the agent upon running for agents with dynamic triggers.
+             */
+            input: string | null;
+            /**
+             * Metadata
+             * @description Metadata to make available for string substitution expressions in agent tasks.
+             */
+            metadata: {
+                [key: string]: components["schemas"]["JsonValue"];
+            } | null;
+            /**
+             * Priority
+             * @description If true, the agent run will be treated as priority execution.
+             * @default false
+             */
+            priority: boolean;
+        };
+        /** AgentRunResponse */
+        AgentRunResponse: {
+            /**
+             * Attempts
+             * @description List of attempts made for this agent run.
+             */
+            attempts: components["schemas"]["AgentRunAttemptResponse"][];
+            /**
+             * Credits
+             * @description Credits consumed by the agent run, if applicable.
+             */
+            credits: number | null;
+            /**
+             * Error Count
+             * @description Number of errors encountered during the run.
+             */
+            error_count: number;
+            /**
+             * Input
+             * @description Input provided to the agent for this run.
+             */
+            input: string | null;
+            /**
+             * Output
+             * @description Output produced by the agent run.
+             */
+            output: string | null;
+            /**
+             * Priority
+             * @description Indicates if the run was treated as a priority execution.
+             */
+            priority: boolean;
+            /**
+             * Run Id
+             * @description Unique identifier for the agent run.
+             */
+            run_id: string;
+            /** @description Current status of the agent run. */
+            status: components["schemas"]["PendingProcessingCompletedFailedStatus"];
+        };
+        /** Body_upload_file_to_source_api_sources__source_connection_id__upload_post */
+        Body_upload_file_to_source_api_sources__source_connection_id__upload_post: {
+            /**
+             * File
+             * Format: binary
+             * @description File to upload
+             */
+            file: string;
+            /**
+             * Title
+             * @description Optional title for the content
+             */
+            title?: string;
+        };
+        /**
+         * ContentEmbeddingResponse
+         * @description Response model for content embedding.
+         */
+        ContentEmbeddingResponse: {
+            /** Batch Duration */
+            batch_duration: number;
+            /** Batch Size */
+            batch_size: number;
+            /** Id */
+            id: string;
+            /** Text */
+            text: string;
+            /** Text End */
+            text_end: number;
+            /** Text Start */
+            text_start: number;
+            /** Vector */
+            vector: number[];
+        };
+        /**
+         * FileUploadResponse
+         * @description Response model for file upload
+         */
+        FileUploadResponse: {
+            /**
+             * Content Version Id
+             * @description ID of the created content version
+             */
+            content_version_id: string | null;
+            /**
+             * Filename
+             * @description Original filename
+             */
+            filename: string;
+            /**
+             * Source Connection Content Version Id
+             * @description ID of the duplicate source connection content version
+             */
+            source_connection_content_version_id: string | null;
+            /**
+             * Status
+             * @description Processing status
+             */
+            status: string;
+        };
+        /** HTTPValidationError */
+        HTTPValidationError: {
+            /** Detail */
+            detail?: components["schemas"]["ValidationError"][];
+        };
+        JsonValue: unknown;
+        /**
+         * PaginationResponse
+         * @description Pagination information.
+         */
+        PaginationResponse: {
+            /** Has Next */
+            has_next: boolean;
+            /** Has Prev */
+            has_prev: boolean;
+            /** Limit */
+            limit: number;
+            /** Page */
+            page: number;
+            /** Pages */
+            pages: number;
+            /** Total */
+            total: number;
+        };
+        /**
+         * PendingProcessingCompletedFailedStatus
+         * @enum {string}
+         */
+        PendingProcessingCompletedFailedStatus: "pending" | "processing" | "completed" | "failed";
+        /**
+         * SourceResponse
+         * @description Response model for source data.
+         */
+        SourceResponse: {
+            /**
+             * Account Id
+             * Format: uuid
+             * @description Account ID associated with the source.
+             */
+            account_id: string;
+            /**
+             * Avg Episodes Per Month
+             * @description Average number of episodes per month.
+             */
+            avg_episodes_per_month?: number | null;
+            /**
+             * Avg Words Per Episode
+             * @description Average number of words per episode.
+             */
+            avg_words_per_episode?: number | null;
+            /**
+             * Chunk Language
+             * @description Language used for chunking content.
+             */
+            chunk_language?: string | null;
+            /**
+             * Chunk Overlap
+             * @description Chunk overlap for content processing.
+             */
+            chunk_overlap?: number | null;
+            /**
+             * Chunk Regex Separators
+             * @description Indicates if chunk separators are regex patterns.
+             */
+            chunk_regex_separators?: boolean | null;
+            /**
+             * Chunk Separators
+             * @description Chunk separators used for content processing.
+             */
+            chunk_separators?: string | null;
+            /**
+             * Chunk Size
+             * @description Chunk size for content processing.
+             */
+            chunk_size?: number | null;
+            /**
+             * Content Count
+             * @description Number of content items associated with the source connection.
+             * @default 0
+             */
+            content_count: number;
+            /**
+             * Content Filter
+             * @description Content filter for the source connection.
+             */
+            content_filter: string;
+            /**
+             * Created At
+             * @description Timestamp when the source connection was created.
+             */
+            created_at: string;
+            /**
+             * Dimensions
+             * @description Dimensions of the embedding model.
+             */
+            dimensions?: number | null;
+            /**
+             * Embedding Model
+             * @description Embedding model used for the source connection.
+             */
+            embedding_model?: string | null;
+            /**
+             * Embedding Model Type
+             * @description Type of the embedding model.
+             */
+            embedding_model_type?: string | null;
+            /**
+             * Has Historical Data
+             * @description Indicates if the source connection has historical data.
+             * @default false
+             */
+            has_historical_data: boolean;
+            /**
+             * Id
+             * @description Unique identifier for the source connection.
+             */
+            id: string;
+            /**
+             * Name
+             * @description Name of the source connection.
+             */
+            name: string;
+            /**
+             * Next Poll At
+             * @description Timestamp for the next scheduled poll.
+             */
+            next_poll_at: string | null;
+            /**
+             * Polling
+             * @description Polling configuration for the source connection.
+             */
+            polling: string | null;
+            /**
+             * Polling Action
+             * @description Polling action for the source connection.
+             */
+            polling_action: string | null;
+            /**
+             * Polling Max Items
+             * @description Maximum items to poll for the source connection.
+             */
+            polling_max_items: number | null;
+            /**
+             * Pulled At
+             * @description Timestamp when content was last pulled.
+             */
+            pulled_at: string | null;
+            /**
+             * Readonly
+             * @description Indicates if the source connection is read-only.
+             * @default false
+             */
+            readonly: boolean;
+            /**
+             * Retention
+             * @description Retention period for the source connection.
+             */
+            retention: number | null;
+            /**
+             * Source Type
+             * @description Type of the source connection.
+             */
+            source_type: string;
+            /**
+             * Updated At
+             * @description Timestamp when the source connection was last updated.
+             */
+            updated_at: string;
+            /**
+             * Url
+             * @description URL of the source connection.
+             */
+            url: string | null;
+        };
+        /** ValidationError */
+        ValidationError: {
+            /** Location */
+            loc: (string | number)[];
+            /** Message */
+            msg: string;
+            /** Error Type */
+            type: string;
+        };
+        /** AgentRunListResponse */
+        routers__api__agents__AgentRunListResponse: {
+            /**
+             * Data
+             * @description List of agent runs.
+             */
+            data: components["schemas"]["AgentRunResponse"][];
+            pagination: components["schemas"]["PaginationResponse"];
+        };
+        /**
+         * ContentDetailResponse
+         * @description Response model for content detail.
+         */
+        routers__api__contents__ContentDetailResponse: {
+            /**
+             * Content Duration
+             * @description Duration of the content in seconds.
+             */
+            content_duration: number | null;
+            /**
+             * Content Duration Display
+             * @description Display string for content duration.
+             */
+            content_duration_display: string | null;
+            /**
+             * Content Status
+             * @description Status of the content.
+             */
+            content_status: string;
+            /**
+             * Content Type
+             * @description Type of the content.
+             */
+            content_type: string;
+            /**
+             * Content Type Display
+             * @description Display name of the content type.
+             */
+            content_type_display: string;
+            /**
+             * Content Url
+             * @description URL of the content.
+             */
+            content_url: string;
+            /**
+             * Content Word Count
+             * @description Word count of the content.
+             */
+            content_word_count: number | null;
+            /**
+             * Description
+             * @description Description of the content.
+             */
+            description: string | null;
+            /**
+             * Error
+             * @description Error message, if any.
+             */
+            error: string | null;
+            /**
+             * Id
+             * @description Unique identifier for the content version.
+             */
+            id: string;
+            /**
+             * Metadata
+             * @description Metadata associated with the content.
+             */
+            metadata: {
+                [key: string]: string;
+            }[] | null;
+            /**
+             * Published At
+             * @description Timestamp when the content was published.
+             */
+            published_at: string | null;
+            /**
+             * Pulled At
+             * @description Timestamp when the content was pulled.
+             */
+            pulled_at: string;
+            /**
+             * Source Connection Content Version Id
+             * @description ID of the source connection content version.
+             */
+            source_connection_content_version_id: string;
+            /**
+             * Source Connection Id
+             * @description ID of the source connection.
+             */
+            source_connection_id: string;
+            /**
+             * Source Name
+             * @description Name of the source.
+             */
+            source_name: string;
+            /**
+             * Source Type
+             * @description Type of the source.
+             */
+            source_type: string;
+            /**
+             * Text Content
+             * @description Text content.
+             */
+            text_content: string | null;
+            /**
+             * Text Content End
+             * @description End position of the text content.
+             */
+            text_content_end: number;
+            /**
+             * Text Content Start
+             * @description Start position of the text content.
+             */
+            text_content_start: number;
+            /**
+             * Text Content Total Length
+             * @description Total length of the text content.
+             */
+            text_content_total_length: number;
+            /**
+             * Title
+             * @description Title of the content.
+             */
+            title: string | null;
+        };
+        /**
+         * ContentEmbeddingsListResponse
+         * @description Response model for paginated content embeddings.
+         */
+        routers__api__contents__ContentEmbeddingsListResponse: {
+            /** Data */
+            data: components["schemas"]["ContentEmbeddingResponse"][];
+            pagination: components["schemas"]["PaginationResponse"];
+        };
+        /**
+         * SourceListResponse
+         * @description Response model for paginated source list
+         */
+        routers__api__sources__SourceListResponse: {
+            /** Data */
+            data: components["schemas"]["SourceResponse"][];
+            pagination: components["schemas"]["PaginationResponse"];
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+
+/** JSON-serializable values accepted/returned by the SDK's low-level `request()` method. */
+type JSONValue = {
+    [key: string]: JSONValue;
+} | JSONValue[] | string | number | boolean | null;
+/** Request body for starting an agent run. */
+type AgentRunRequest = components["schemas"]["AgentRunRequest"];
+/** Response body describing an agent run. */
+type AgentRunResponse = components["schemas"]["AgentRunResponse"];
+/** Paginated list response for agent runs. */
+type AgentRunListResponse = components["schemas"]["routers__api__agents__AgentRunListResponse"];
+/** Content detail response for a specific content version. */
+type ContentDetailResponse = components["schemas"]["routers__api__contents__ContentDetailResponse"];
+/** Paginated list response for embeddings. */
+type ContentEmbeddingsListResponse = components["schemas"]["routers__api__contents__ContentEmbeddingsListResponse"];
+/** Paginated list response for sources. */
+type SourceListResponse = components["schemas"]["routers__api__sources__SourceListResponse"];
+/** Upload response for source uploads. */
+type FileUploadResponse = components["schemas"]["FileUploadResponse"];
+/** Standard OpenAPI validation error shape (typically HTTP 422). */
+type HTTPValidationError = components["schemas"]["HTTPValidationError"];
+
+/** Default API base URL (can be overridden with `baseUrl` or `SECLAI_API_URL`). */
+declare const SECLAI_API_URL = "https://seclai.com";
+/** A `fetch`-compatible function (e.g. `globalThis.fetch` or `undici.fetch`). */
+type FetchLike = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+/** Configuration for the {@link Seclai} client. */
+interface SeclaiOptions {
+    /** API key used for authentication. Defaults to `process.env.SECLAI_API_KEY` when available. */
+    apiKey?: string;
+    /** API base URL. Defaults to `process.env.SECLAI_API_URL` when available, else {@link SECLAI_API_URL}. */
+    baseUrl?: string;
+    /** Header name to use for the API key. Defaults to `x-api-key`. */
+    apiKeyHeader?: string;
+    /** Extra headers to include on every request. */
+    defaultHeaders?: Record<string, string>;
+    /** Optional `fetch` implementation for environments without a global `fetch`. */
+    fetch?: FetchLike;
+}
+/**
+ * Seclai JavaScript/TypeScript client.
+ *
+ * @remarks
+ * - Uses API key auth via `x-api-key` by default.
+ * - Throws SDK exceptions for non-success responses.
+ */
+declare class Seclai {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly apiKeyHeader;
+    private readonly defaultHeaders;
+    private readonly fetcher;
+    /**
+     * Create a new Seclai client.
+     *
+     * @param opts - Client configuration.
+     * @throws {@link SeclaiConfigurationError} If no API key is provided (and `SECLAI_API_KEY` is not set).
+     * @throws {@link SeclaiConfigurationError} If no `fetch` implementation is available.
+     */
+    constructor(opts?: SeclaiOptions);
+    /**
+     * Make a raw HTTP request to the Seclai API.
+     *
+     * This is a low-level escape hatch. For most operations, prefer the typed convenience methods.
+     *
+     * @param method - HTTP method (e.g. `"GET"`, `"POST"`).
+     * @param path - Request path relative to `baseUrl` (e.g. `"/api/sources/"`).
+     * @param opts - Query params, JSON body, and per-request headers.
+     * @returns Parsed JSON for JSON responses, raw text for non-JSON responses, or `null` for empty bodies.
+     * @throws {@link SeclaiAPIValidationError} For validation errors (typically HTTP 422).
+     * @throws {@link SeclaiAPIStatusError} For other non-success HTTP status codes.
+     */
+    request(method: string, path: string, opts?: {
+        query?: Record<string, unknown>;
+        json?: unknown;
+        headers?: Record<string, string>;
+    }): Promise<unknown | string | null>;
+    /**
+     * Run an agent.
+     *
+     * @param agentId - Agent identifier.
+     * @param body - Agent run request payload.
+     * @returns The created agent run.
+     */
+    runAgent(agentId: string, body: AgentRunRequest): Promise<AgentRunResponse>;
+    /**
+     * List agent runs for an agent.
+     *
+     * @param agentId - Agent identifier.
+     * @param opts - Pagination options.
+     * @returns A paginated list of runs.
+     */
+    listAgentRuns(agentId: string, opts?: {
+        page?: number;
+        limit?: number;
+    }): Promise<AgentRunListResponse>;
+    /**
+     * Get details of a specific agent run.
+     *
+     * @param agentId - Agent identifier.
+     * @param runId - Run identifier.
+     * @returns Agent run details.
+     */
+    getAgentRun(agentId: string, runId: string): Promise<AgentRunResponse>;
+    /**
+     * Cancel an agent run.
+     *
+     * @param agentId - Agent identifier.
+     * @param runId - Run identifier.
+     * @returns Updated agent run record.
+     */
+    deleteAgentRun(agentId: string, runId: string): Promise<AgentRunResponse>;
+    /**
+     * Get content detail.
+     *
+     * Fetches a slice of a content version (use `start`/`end` to page through large content).
+     *
+     * @param sourceConnectionContentVersion - Content version identifier.
+     * @param opts - Range options.
+     * @returns Content details for the requested range.
+     */
+    getContentDetail(sourceConnectionContentVersion: string, opts?: {
+        start?: number;
+        end?: number;
+    }): Promise<ContentDetailResponse>;
+    /**
+     * Delete a specific content version.
+     *
+     * @param sourceConnectionContentVersion - Content version identifier.
+     */
+    deleteContent(sourceConnectionContentVersion: string): Promise<void>;
+    /**
+     * List embeddings for a content version.
+     *
+     * @param sourceConnectionContentVersion - Content version identifier.
+     * @param opts - Pagination options.
+     * @returns A paginated list of embeddings.
+     */
+    listContentEmbeddings(sourceConnectionContentVersion: string, opts?: {
+        page?: number;
+        limit?: number;
+    }): Promise<ContentEmbeddingsListResponse>;
+    /**
+     * List sources.
+     *
+     * @param opts - Pagination and filter options.
+     * @returns A paginated list of sources.
+     */
+    listSources(opts?: {
+        page?: number;
+        limit?: number;
+        sort?: string;
+        order?: "asc" | "desc";
+        accountId?: string | null;
+    }): Promise<SourceListResponse>;
+    /**
+     * Upload a file to a specific source connection.
+     *
+     * @param sourceConnectionId - Source connection identifier.
+     * @param opts - File payload and optional metadata.
+     * @param opts.file - File payload as a `Blob`, `Uint8Array`, or `ArrayBuffer`.
+     * @param opts.title - Optional title for the uploaded file.
+     * @param opts.fileName - Optional filename to send with the upload.
+     * @param opts.mimeType - Optional MIME type to attach to the upload.
+     * @returns Upload response details.
+     */
+    uploadFileToSource(sourceConnectionId: string, opts: {
+        file: Blob | Uint8Array | ArrayBuffer;
+        title?: string;
+        fileName?: string;
+        mimeType?: string;
+    }): Promise<FileUploadResponse>;
+}
+
+/** Base error class for the Seclai SDK. */
+declare class SeclaiError extends Error {
+    constructor(message: string);
+}
+/** Thrown when the SDK is misconfigured (for example, missing API key). */
+declare class SeclaiConfigurationError extends SeclaiError {
+    constructor(message: string);
+}
+/**
+ * Thrown when the API returns a non-success status code.
+ *
+ * @remarks
+ * Use {@link SeclaiAPIValidationError} for HTTP 422 validation errors.
+ */
+declare class SeclaiAPIStatusError extends SeclaiError {
+    /** HTTP status code returned by the API. */
+    readonly statusCode: number;
+    /** HTTP method used for the request. */
+    readonly method: string;
+    /** Full request URL. */
+    readonly url: string;
+    /** Best-effort response body text (if available). */
+    readonly responseText: string | undefined;
+    constructor(opts: {
+        /** Human-readable error message. */
+        message: string;
+        statusCode: number;
+        method: string;
+        url: string;
+        responseText: string | undefined;
+    });
+}
+/**
+ * Thrown when the API returns a validation error response (typically HTTP 422).
+ *
+ * The `validationError` field contains the decoded validation payload when available.
+ */
+declare class SeclaiAPIValidationError extends SeclaiAPIStatusError {
+    /** Parsed validation error payload (best-effort). */
+    readonly validationError: unknown;
+    constructor(opts: {
+        message: string;
+        statusCode: number;
+        method: string;
+        url: string;
+        responseText: string | undefined;
+        validationError: unknown;
+    });
+}
+
+export { type AgentRunListResponse, type AgentRunRequest, type AgentRunResponse, type ContentDetailResponse, type ContentEmbeddingsListResponse, type FetchLike, type FileUploadResponse, type HTTPValidationError, type JSONValue, SECLAI_API_URL, Seclai, SeclaiAPIStatusError, SeclaiAPIValidationError, SeclaiConfigurationError, SeclaiError, type SeclaiOptions, type SourceListResponse };