@knowledge-stack/ksapi — Knowledge Stack TypeScript SDK

Focus on agents. We handle document intelligence.

TypeScript / JavaScript client for the Knowledge Stack API.

Install

npm install @knowledge-stack/ksapi
# or
pnpm add @knowledge-stack/ksapi
# or
yarn add @knowledge-stack/ksapi
# or
bun add @knowledge-stack/ksapi

Quickstart

import { Configuration, FoldersApi, DocumentsApi } from "@knowledge-stack/ksapi";

const config = new Configuration({
  basePath: process.env.KS_BASE_URL ?? "https://api.knowledgestack.ai",
  accessToken: process.env.KS_API_KEY, // sk-user-...
});

const folders = new FoldersApi(config);
const result = await folders.listFolderContents({ folderId: "..." });
console.log(result.data);

Runs in Node.js ≥ 18, Bun, Deno, Cloudflare Workers, and modern browsers.

Related repos

• ks-cookbook — 32 production-style agent demos.
• ks-mcp — MCP server for agent frameworks (recommended for most agent use cases).
• ks-sdk-python — Python counterpart of this SDK (ksapi on PyPI).
• ks-docs — cross-SDK reference docs.

For agent / RAG workflows, prefer the MCP server (ks-mcp). Use this SDK when you need admin / write operations or are building infrastructure (ingestion pipelines, schedulers, tenant management).

Generation

This package is generated from the Knowledge Stack OpenAPI spec by OpenAPI Generator. API-shape issues belong upstream; client-side wrapper / packaging bugs belong here.

Below this line is auto-generated reference content.

---

@knowledge-stack/ksapi@1.67.0

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install @knowledge-stack/ksapi --save

Next, try it out.

import {
  Configuration,
  ApiKeysApi,
} from '@knowledge-stack/ksapi';
import type { CreateApiKeyOperationRequest } from '@knowledge-stack/ksapi';

async function example() {
  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
  const api = new ApiKeysApi();

  const body = {
    // CreateApiKeyRequest
    createApiKeyRequest: ...,
    // string (optional)
    ksUat: ksUat_example,
  } satisfies CreateApiKeyOperationRequest;

  try {
    const data = await api.createApiKey(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to http://localhost:8000

Class	Method	HTTP request	Description
ApiKeysApi	createApiKey	POST /v1/api-keys	Create Api Key Handler
ApiKeysApi	deleteApiKey	DELETE /v1/api-keys/{api_key_id}	Delete Api Key Handler
ApiKeysApi	getApiKey	GET /v1/api-keys/{api_key_id}	Get Api Key Handler
ApiKeysApi	listApiKeys	GET /v1/api-keys	List Api Keys Handler
AuthApi	createPasswordUser	POST /v1/auth/pw/user	Create Password User Handler
AuthApi	fanweiDirectorySync	POST /v1/auth/sso/{tenant_id}/directory_sync	Directory Sync Handler
AuthApi	fanweiDirectorySync_0	POST /v1/auth/sso/{tenant_id}/directory_sync	Directory Sync Handler
AuthApi	initiateSso	POST /v1/auth/sso/initiate	Initiate Sso Handler
AuthApi	oauth2Callback	GET /v1/auth/sso/oauth2/callback	Oauth2 Callback Handler
AuthApi	pwEmailVerification	POST /v1/auth/pw/email_verification	Pw Email Verification Handler
AuthApi	pwSignin	POST /v1/auth/pw/signin	Signin Handler
AuthApi	refreshUat	POST /v1/auth/uat	Refresh Uat Handler
AuthApi	resetPassword	POST /v1/auth/pw/reset	Reset Password Handler
AuthApi	resetPasswordWithToken	POST /v1/auth/pw/reset_with_token	Reset Password With Token Handler
AuthApi	sendPwResetEmail	POST /v1/auth/pw/send_reset_email	Send Pw Reset Email Handler
AuthApi	signout	POST /v1/auth/signout	Signout Handler
AuthApi	ssoSignin	GET /v1/auth/sso/{tenant_id}/signin	Sso Login Handler
BillingApi	adminClearEnterpriseOverride	DELETE /v1/billing/admin/tenants/{tenant_id}/overrides	Admin Clear Enterprise Override Handler
BillingApi	adminSetEnterpriseOverride	PUT /v1/billing/admin/tenants/{tenant_id}/overrides	Admin Set Enterprise Override Handler
BillingApi	cancelTenantSubscription	POST /v1/billing/subscription/cancel	Cancel Tenant Subscription Handler
BillingApi	createBillingCheckoutSession	POST /v1/billing/checkout-session	Create Billing Checkout Session Handler
BillingApi	createBillingPortalSession	POST /v1/billing/portal-session	Create Billing Portal Session Handler
BillingApi	getCurrentUserUsage	GET /v1/billing/usage/me	Get Current User Usage Handler
BillingApi	getTenantSubscription	GET /v1/billing/subscription	Get Tenant Subscription Handler
BillingApi	getTenantUsage	GET /v1/billing/usage	Get Tenant Usage Handler
BillingApi	listBillingPlans	GET /v1/billing/plans	List Billing Plans Handler
BillingApi	resumeTenantSubscription	POST /v1/billing/subscription/resume	Resume Tenant Subscription Handler
ChunkLineagesApi	createChunkLineage	POST /v1/chunk-lineages	Create Chunk Lineage Handler
ChunkLineagesApi	deleteChunkLineage	DELETE /v1/chunk-lineages	Delete Chunk Lineage Handler
ChunkLineagesApi	getChunkLineage	GET /v1/chunk-lineages/{chunk_id}	Get Chunk Lineage Handler
ChunksApi	createChunk	POST /v1/chunks	Create Chunk Handler
ChunksApi	deleteChunk	DELETE /v1/chunks/{chunk_id}	Delete Chunk Handler
ChunksApi	getChunk	GET /v1/chunks/{chunk_id}	Get Chunk Handler
ChunksApi	getChunkNeighbors	GET /v1/chunks/{chunk_id}/neighbors	Get Chunk Neighbors Handler
ChunksApi	getChunksBulk	GET /v1/chunks/bulk	Get Chunks Bulk Handler
ChunksApi	getVersionChunkIds	GET /v1/chunks/version-chunk-ids	Get Version Chunk Ids Handler
ChunksApi	searchChunks	POST /v1/chunks/search	Search Chunks Handler
ChunksApi	updateChunkContent	PATCH /v1/chunks/{chunk_id}/content	Update Chunk Content Handler
ChunksApi	updateChunkMetadata	PATCH /v1/chunks/{chunk_id}	Update Chunk Metadata Handler
DefaultApi	healthCheck	GET /healthz	Health Check Handler
DefaultApi	hello	GET /	Root Handler
DocumentVersionsApi	clearDocumentVersionContents	DELETE /v1/document_versions/{version_id}/contents	Clear Document Version Contents Handler
DocumentVersionsApi	createDocumentVersion	POST /v1/documents/{document_id}/versions	Create Document Version Handler
DocumentVersionsApi	deleteDocumentVersion	DELETE /v1/document_versions/{version_id}	Delete Document Version Handler
DocumentVersionsApi	documentVersionAction	POST /v1/document_versions/{version_id}	Document Version Action Handler
DocumentVersionsApi	getDocumentVersion	GET /v1/document_versions/{version_id}	Get Document Version Handler
DocumentVersionsApi	getDocumentVersionContents	GET /v1/document_versions/{version_id}/contents	Get Document Version Contents Handler
DocumentVersionsApi	listDocumentVersions	GET /v1/document_versions	List Document Versions Handler
DocumentVersionsApi	updateDocumentVersionMetadata	PATCH /v1/document_versions/{version_id}/metadata	Update Document Version Metadata Handler
DocumentsApi	createDocument	POST /v1/documents	Create Document Handler
DocumentsApi	deleteDocument	DELETE /v1/documents/{document_id}	Delete Document Handler
DocumentsApi	getDocument	GET /v1/documents/{document_id}	Get Document Handler
DocumentsApi	ingestDocument	POST /v1/documents/ingest	Ingest Document Handler
DocumentsApi	ingestDocumentVersion	POST /v1/documents/{document_id}/ingest	Ingest Document Version Handler
DocumentsApi	listDocuments	GET /v1/documents	List Documents Handler
DocumentsApi	updateDocument	PATCH /v1/documents/{document_id}	Update Document Handler
FeaturesApi	getFeatures	GET /v1/features	Get Features Handler
FeedbackApi	deleteFeedback	DELETE /v1/feedback/{feedback_id}	Delete Feedback Handler
FeedbackApi	listFeedback	GET /v1/feedback	List Feedback Handler
FeedbackApi	submitFeedback	POST /v1/feedback	Submit Feedback Handler
FoldersApi	createFolder	POST /v1/folders	Create Folder Handler
FoldersApi	deleteFolder	DELETE /v1/folders/{folder_id}	Delete Folder Handler
FoldersApi	folderAction	POST /v1/folders/{folder_id}	Folder Action Handler
FoldersApi	getFolder	GET /v1/folders/{folder_id}	Get Folder Handler
FoldersApi	listFolderContents	GET /v1/folders/{folder_id}/contents	List Folder Contents Handler
FoldersApi	listFolders	GET /v1/folders	List Folders Handler
FoldersApi	searchItems	GET /v1/folders/search	Search Items Handler
FoldersApi	updateFolder	PATCH /v1/folders/{folder_id}	Update Folder Handler
InvitesApi	acceptInvite	POST /v1/invites/{invite_id}/accept	Accept Invite
InvitesApi	createInvite	POST /v1/invites	Create Invite
InvitesApi	deleteInvite	DELETE /v1/invites/{invite_id}	Delete Invite
InvitesApi	listInvites	GET /v1/invites	List Invites Handler
PathPartsApi	bulkAddPathPartTags	POST /v1/path-parts/{path_part_id}/tags	Bulk Add Path Part Tags Handler
PathPartsApi	bulkRemovePathPartTags	DELETE /v1/path-parts/{path_part_id}/tags	Bulk Remove Path Part Tags Handler
PathPartsApi	getPathPart	GET /v1/path-parts/{path_part_id}	Get Path Part Handler
PathPartsApi	getPathPartAncestry	GET /v1/path-parts/{path_part_id}/ancestry	Get Path Part Ancestry Handler
PathPartsApi	getPathPartSubtreeChunks	GET /v1/path-parts/{path_part_id}/subtree_chunks	Get Path Part Subtree Chunks Handler
PathPartsApi	getPathPartTags	GET /v1/path-parts/{path_part_id}/tags	Get Path Part Tags Handler
PathPartsApi	listPathParts	GET /v1/path-parts	List Path Parts Handler
SectionsApi	createSection	POST /v1/sections	Create Section Handler
SectionsApi	deleteSection	DELETE /v1/sections/{section_id}	Delete Section Handler
SectionsApi	dissolveSection	POST /v1/sections/{section_id}/dissolve	Dissolve Section Handler
SectionsApi	getSection	GET /v1/sections/{section_id}	Get Section Handler
SectionsApi	getSectionsBulk	GET /v1/sections/bulk	Get Sections Bulk Handler
SectionsApi	updateSection	PATCH /v1/sections/{section_id}	Update Section Handler
TagsApi	createTag	POST /v1/tags	Create Tag Handler
TagsApi	deleteTag	DELETE /v1/tags/{tag_id}	Delete Tag Handler
TagsApi	getTag	GET /v1/tags/{tag_id}	Get Tag Handler
TagsApi	listTags	GET /v1/tags	List Tags Handler
TagsApi	updateTag	PATCH /v1/tags/{tag_id}	Update Tag Handler
TenantGroupsApi	addGroupMember	POST /v1/tenant-groups/{group_id}/members	Add Group Member Handler
TenantGroupsApi	createGroupPermission	POST /v1/tenant-groups/{group_id}/permissions	Create Group Permission Handler
TenantGroupsApi	createTenantGroup	POST /v1/tenant-groups	Create Tenant Group Handler
TenantGroupsApi	deleteGroupPermission	DELETE /v1/tenant-groups/{group_id}/permissions/{permission_id}	Delete Group Permission Handler
TenantGroupsApi	deleteTenantGroup	DELETE /v1/tenant-groups/{group_id}	Delete Tenant Group Handler
TenantGroupsApi	getTenantGroup	GET /v1/tenant-groups/{group_id}	Get Tenant Group Handler
TenantGroupsApi	listGroupMembers	GET /v1/tenant-groups/{group_id}/members	List Group Members Handler
TenantGroupsApi	listGroupPermissions	GET /v1/tenant-groups/{group_id}/permissions	List Group Permissions Handler
TenantGroupsApi	listMyGroups	GET /v1/tenant-groups/my-group	List My Groups Handler
TenantGroupsApi	listTenantGroups	GET /v1/tenant-groups	List Tenant Groups Handler
TenantGroupsApi	removeGroupMember	DELETE /v1/tenant-groups/{group_id}/members/{user_id}	Remove Group Member Handler
TenantGroupsApi	updateGroupPermission	PATCH /v1/tenant-groups/{group_id}/permissions/{permission_id}	Update Group Permission Handler
TenantGroupsApi	updateTenantGroup	PATCH /v1/tenant-groups/{group_id}	Update Tenant Group Handler
TenantsApi	activateTenantUser	POST /v1/tenants/{tenant_id}/users/{user_id}/activate	Activate Tenant User Handler
TenantsApi	deactivateTenantUser	POST /v1/tenants/{tenant_id}/users/{user_id}/deactivate	Deactivate Tenant User Handler
TenantsApi	deleteTenant	DELETE /v1/tenants/{tenant_id}	Delete Tenant
TenantsApi	deleteTenantLogo	DELETE /v1/tenants/{tenant_id}/branding/logo	Delete Tenant Logo
TenantsApi	deleteTenantUser	DELETE /v1/tenants/{tenant_id}/users/{user_id}	Delete Tenant User Handler
TenantsApi	getTenant	GET /v1/tenants/{tenant_id}	Get Tenant
TenantsApi	listTenantUsers	GET /v1/tenants/{tenant_id}/users	List Tenant Users
TenantsApi	listTenants	GET /v1/tenants	List Tenants
TenantsApi	updateTenant	PATCH /v1/tenants/{tenant_id}	Update Tenant
TenantsApi	updateTenantUser	PATCH /v1/tenants/{tenant_id}/users/{user_id}	Update Tenant User
TenantsApi	uploadTenantLogo	POST /v1/tenants/{tenant_id}/branding/logo	Upload Tenant Logo
ThreadMessagesApi	createThreadMessage	POST /v1/threads/{thread_id}/messages	Create Thread Message Handler
ThreadMessagesApi	getThreadMessage	GET /v1/threads/{thread_id}/messages/{message_id}	Get Thread Message Handler
ThreadMessagesApi	listThreadMessages	GET /v1/threads/{thread_id}/messages	List Thread Messages Handler
ThreadsApi	createThread	POST /v1/threads	Create Thread Handler
ThreadsApi	deleteThread	DELETE /v1/threads/{thread_id}	Delete Thread Handler
ThreadsApi	getThread	GET /v1/threads/{thread_id}	Get Thread Handler
ThreadsApi	listThreads	GET /v1/threads	List Threads Handler
ThreadsApi	sendUserMessage	POST /v1/threads/{thread_id}/user_message	Send User Message Handler
ThreadsApi	streamThread	GET /v1/threads/{thread_id}/stream	Stream Thread Handler
ThreadsApi	updateThread	PATCH /v1/threads/{thread_id}	Update Thread Handler
UserPermissionsApi	createUserPermission	POST /v1/user-permissions	Create User Permission Handler
UserPermissionsApi	deleteUserPermission	DELETE /v1/user-permissions/{permission_id}	Delete User Permission Handler
UserPermissionsApi	listUserPermissions	GET /v1/user-permissions	List User Permissions Handler
UserPermissionsApi	updateUserPermission	PATCH /v1/user-permissions/{permission_id}	Update User Permission Handler
UsersApi	getMe	GET /v1/users/me	Get Me Handler
UsersApi	updateMe	PATCH /v1/users	Update Me Handler
WorkflowDefinitionsApi	createWorkflowDefinition	POST /v1/workflow-definitions	Create Workflow Definition Handler
WorkflowDefinitionsApi	deleteWorkflowDefinition	DELETE /v1/workflow-definitions/{definition_id}	Delete Workflow Definition Handler
WorkflowDefinitionsApi	getWorkflowDefinition	GET /v1/workflow-definitions/{definition_id}	Get Workflow Definition Handler
WorkflowDefinitionsApi	invokeWorkflow	POST /v1/workflow-definitions/{definition_id}/invoke	Invoke Workflow Handler
WorkflowDefinitionsApi	listWorkflowDefinitions	GET /v1/workflow-definitions	List Workflow Definitions Handler
WorkflowDefinitionsApi	listWorkflowRuns	GET /v1/workflow-definitions/{definition_id}/runs	List Workflow Runs Handler
WorkflowDefinitionsApi	updateWorkflowDefinition	PUT /v1/workflow-definitions/{definition_id}	Update Workflow Definition Handler
WorkflowRunsApi	deleteWorkflowRun	DELETE /v1/workflow-runs/{run_id}	Delete Workflow Run Handler
WorkflowRunsApi	getWorkflowRun	GET /v1/workflow-runs/{run_id}	Get Workflow Run Handler
WorkflowRunsApi	workflowRunCallback	POST /v1/workflow-runs/{run_id}/callback	Workflow Run Callback Handler
WorkflowsApi	cancelTemporalWorkflow	DELETE /v1/workflows/{workflow_id}	Cancel Temporal Workflow Handler
WorkflowsApi	dvWorkflowRerun	POST /v1/workflows/document_versions/{workflow_id}	Dv Workflow Rerun Handler
WorkflowsApi	getDvWorkflow	GET /v1/workflows/document_versions/{workflow_id}	Get Dv Workflow Handler
WorkflowsApi	getTemporalWorkflowStatus	GET /v1/workflows/{workflow_id}	Get Temporal Workflow Status Handler
WorkflowsApi	listDvWorkflows	GET /v1/workflows/document_versions	List Dv Workflows Handler

Models

• ABCDPathSnapshot
• AcceptInviteResponse
• AddMemberRequest
• AncestryResponse
• ApiKeyResponse
• Args
• BillingCadence
• BillingPlanResponse
• BillingPlanTier
• BrandingLogoType
• BulkTagRequest
• ChunkBulkResponse
• ChunkContentItem
• ChunkDocumentResponse
• ChunkDocumentVersionResponse
• ChunkLineageResponse
• ChunkMetadataInput
• ChunkMetadataOutput
• ChunkNeighborsResponse
• ChunkResponse
• ChunkSearchRequest
• ChunkType
• Citation
• ClearVersionContentsResponse
• CreateApiKeyRequest
• CreateApiKeyResponse
• CreateCheckoutSessionRequest
• CreateCheckoutSessionResponse
• CreateChunkLineageRequest
• CreateChunkRequest
• CreateDocumentRequest
• CreateFolderRequest
• CreateGroupPermissionRequest
• CreateGroupRequest
• CreatePasswordUserRequest
• CreatePermissionRequest
• CreatePortalSessionRequest
• CreatePortalSessionResponse
• CreateSectionRequest
• CreateTagRequest
• CreateThreadMessageRequest
• CreateThreadRequest
• CreateWorkflowDefinitionRequest
• DirectorySyncResponse
• DissolveSectionResponse
• DocumentOrigin
• DocumentResponse
• DocumentType
• DocumentVersionAction
• DocumentVersionActionResponse
• DocumentVersionContentTypeFilter
• DocumentVersionMetadata
• DocumentVersionMetadataUpdate
• DocumentVersionResponse
• EffectiveLimitsResponse
• EmailSentResponse
• EmailVerificationRequest
• EnrichedCitation
• EnrichedThreadMessageContent
• FeaturesResponse
• FeedbackEventResponse
• FeedbackRating
• FeedbackReason
• FeedbackTargetType
• FolderAction
• FolderActionResponse
• FolderResponse
• FolderResponseOrDocumentResponse
• GroupPermissionResponse
• GroupResponse
• HTTPValidationError
• HealthCheckResponse
• IdpConfig
• IdpType
• ImageTaxonomy
• InformationStatistics
• IngestDocumentResponse
• IngestionMode
• InviteResponse
• InviteStatus
• InviteUserRequest
• InvokeWorkflowRequest
• LineageEdgeResponse
• LineageGraphResponse
• LineageNodeResponse
• LocationInner
• MembershipResponse
• MessageRole
• NonFilesystemReferenceType
• PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator
• PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator
• PaginatedResponseDocumentResponse
• PaginatedResponseDocumentVersionResponse
• PaginatedResponseFeedbackEventResponse
• PaginatedResponseFolderResponse
• PaginatedResponseGroupPermissionResponse
• PaginatedResponseGroupResponse
• PaginatedResponseInviteResponse
• PaginatedResponseMembershipResponse
• PaginatedResponsePathPartResponse
• PaginatedResponsePermissionResponse
• PaginatedResponseTagResponse
• PaginatedResponseTenantResponse
• PaginatedResponseTenantUserResponse
• PaginatedResponseThreadMessageResponse
• PaginatedResponseThreadResponse
• PaginatedResponseWorkflowDefinitionResponse
• PaginatedResponseWorkflowRunResponse
• PaginatedResponseWorkflowSummaryResponse
• PartType
• PasswordResetRequest
• PasswordResetWithTokenRequest
• PathOrder
• PathPartAncestorItem
• PathPartResponse
• PathPartTagsResponse
• PermissionCapability
• PermissionResponse
• PipelineState
• PipelineStatus
• Polygon
• PolygonReference
• ReferenceType
• ResolvedReferenceInput
• ResolvedReferenceOutput
• RootResponse
• SSOInitiateResponse
• ScoredChunkResponse
• SearchSortOrder
• SearchType
• SearchablePartType
• SectionContentItem
• SectionContentItemOrChunkContentItem
• SectionResponse
• SectionSystemMetadata
• SelfHostedRunnerConfig
• SelfHostedRunnerConfigResponse
• SetEnterpriseOverrideRequest
• SignInRequest
• StepInput
• StepKind
• StepOutput
• SubmitFeedbackRequest
• SubscriptionStatus
• SubtreeChunkGroup
• SubtreeChunksResponse
• SupportedIdP
• SupportedLanguage
• TagResponse
• TemporalWorkflowStatusResponse
• TenantBrandingResponse
• TenantResponse
• TenantSettingsResponse
• TenantSettingsUpdate
• TenantSubscriptionResponse
• TenantUsageResponse
• TenantUserEditRequest
• TenantUserResponse
• TenantUserRole
• ThreadMessageContent
• ThreadMessageDetailsInput
• ThreadMessageDetailsOutput
• ThreadMessageResponse
• ThreadResponse
• UpdateChunkContentRequest
• UpdateChunkMetadataRequest
• UpdateDocumentRequest
• UpdateFolderRequest
• UpdateGroupPermissionRequest
• UpdateGroupRequest
• UpdatePermissionRequest
• UpdateSectionRequest
• UpdateTagRequest
• UpdateTenantRequest
• UpdateThreadRequest
• UpdateUserRequest
• UpdateWorkflowDefinitionRequest
• UserMessageRequest
• UserMessageResponse
• UserResponse
• UserUsageResponse
• ValidationError
• VersionChunkIdsResponse
• WorkflowActionResponse
• WorkflowCallbackResponse
• WorkflowCancelResponse
• WorkflowDefinitionResponse
• WorkflowDetailResponse
• WorkflowRunCallbackRequest
• WorkflowRunResponse
• WorkflowRunSnapshot
• WorkflowRunStatus
• WorkflowRunnerType
• WorkflowSummaryResponse

Authorization

Endpoints do not require authorization.

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 1.67.0
• Generator version: 7.21.0
• Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License