Skip to content
BranchesTags

Repository files navigation

@knowledge-stack/ksapi — Knowledge Stack TypeScript SDK

Focus on agents. We handle document intelligence.

TypeScript / JavaScript client for the Knowledge Stack API.

npm License: MIT Discord

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.153.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,
  AdminKbApi,
} from '@knowledge-stack/ksapi';
import type { GetAdminKbSummaryRequest } from '@knowledge-stack/ksapi';

async function example() {
  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: cookieAuth
    apiKey: "YOUR API KEY",
    // Configure HTTP bearer authorization: bearerAuth
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new AdminKbApi(config);

  try {
    const data = await api.getAdminKbSummary();
    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
AdminKbApi getAdminKbSummary GET /v1/admin/kb/summary Get Admin Kb Summary Handler
AdminKbApi getAdminKbTimeseries GET /v1/admin/kb/timeseries Get Admin Kb Timeseries Handler
AdminWorkflowsApi getAdminWorkflowByHour GET /v1/admin/workflows/by-hour Get Admin Workflow By Hour Handler
AdminWorkflowsApi getAdminWorkflowLeaderboard GET /v1/admin/workflows/leaderboard Get Admin Workflow Leaderboard Handler
AdminWorkflowsApi getAdminWorkflowOutputStats GET /v1/admin/workflows/output-stats Get Admin Workflow Output Stats Handler
AdminWorkflowsApi getAdminWorkflowSummary GET /v1/admin/workflows/summary Get Admin Workflow Summary Handler
AdminWorkflowsApi getAdminWorkflowTimeseries GET /v1/admin/workflows/timeseries Get Admin Workflow Timeseries Handler
AgentApi agentAsk POST /v1/agent/ask Agent Ask Handler
AgentApi agentExtract POST /v1/agent/extract Agent Extract Handler
ApiConnectionsApi acceptApiConnectionDisclaimer POST /v1/api-connections/{connection_id}/disclaimer Accept Api Connection Disclaimer Handler
ApiConnectionsApi createApiConnection POST /v1/api-connections Create Api Connection Handler
ApiConnectionsApi deleteApiConnection DELETE /v1/api-connections/{connection_id} Delete Api Connection Handler
ApiConnectionsApi executeApiConnectionRequest POST /v1/api-connections/{connection_id}/request Execute Api Connection Request Handler
ApiConnectionsApi getApiConnection GET /v1/api-connections/{connection_id} Get Api Connection Handler
ApiConnectionsApi updateApiConnection PATCH /v1/api-connections/{connection_id} Update Api Connection Handler
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
AuditEventsApi exportAuditEvents GET /v1/audit-events/export Export Audit Events Handler
AuditEventsApi listAuditEvents GET /v1/audit-events List Audit Events Handler
AuthApi changePhoneNumber PUT /v1/auth/pw/me/phone_number Change Phone Number Handler
AuthApi createPasswordUser POST /v1/auth/pw/user Create Password User Handler
AuthApi createPhonePasswordUser POST /v1/auth/pw/phone_user Create Phone 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 pwPhoneVerification POST /v1/auth/pw/phone_verification Pw Phone Verification Handler
AuthApi pwSignin POST /v1/auth/pw/signin Signin Handler
AuthApi refreshUat POST /v1/auth/uat Refresh Uat Handler
AuthApi requestPhoneChange POST /v1/auth/pw/me/phone_number/verify Request Phone Change 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
AuthApi validatePwResetCode POST /v1/auth/pw/validate_reset_code Validate Reset Code Handler
BulkDownloadApi startBulkDownload POST /v1/bulk-download Start Bulk Download 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
DataSourcesApi createDataSource POST /v1/data-sources Create Data Source Handler
DataSourcesApi deleteDataSource DELETE /v1/data-sources/{data_source_id} Delete Data Source Handler
DataSourcesApi deleteDataSourceSchema DELETE /v1/data-sources/{data_source_id}/schemas/{schema_id} Delete Data Source Schema Handler
DataSourcesApi deleteDataSourceTable DELETE /v1/data-sources/{data_source_id}/tables/{table_id} Delete Data Source Table Handler
DataSourcesApi describeDataSourceTables POST /v1/data-sources/{data_source_id}/describe Describe Data Source Tables Handler
DataSourcesApi getDataSource GET /v1/data-sources/{data_source_id} Get Data Source Handler
DataSourcesApi getDataSourceCatalog GET /v1/data-sources/{data_source_id}/catalog Get Data Source Catalog Handler
DataSourcesApi listDataSourceSchemas GET /v1/data-sources/{data_source_id}/schemas List Data Source Schemas Handler
DataSourcesApi modelDataSourceTable POST /v1/data-sources/{data_source_id}/tables Model Data Source Table Handler
DataSourcesApi modelDataSourceTables POST /v1/data-sources/{data_source_id}/tables/batch Model Data Source Tables Handler
DataSourcesApi queryDataSource POST /v1/data-sources/{data_source_id}/query Query Data Source Handler
DataSourcesApi searchDataSourceTables POST /v1/data-sources/tables/search Search Data Source Tables Handler
DataSourcesApi syncDataSource POST /v1/data-sources/{data_source_id}/sync Sync Data Source Handler
DataSourcesApi testDataSourceConnection POST /v1/data-sources/{data_source_id}/test Test Data Source Connection Handler
DataSourcesApi testDataSourceConnectionFresh POST /v1/data-sources/test-connection Test Data Source Connection Fresh Handler
DataSourcesApi updateDataSource PATCH /v1/data-sources/{data_source_id} Update Data Source Handler
DataSourcesApi updateDataSourceTable PATCH /v1/data-sources/{data_source_id}/tables/{table_id} Update Data Source Table Handler
DefaultApi healthCheck GET /healthz Health Check Handler
DefaultApi hello GET / Root Handler
DocumentCheckoutApi acquireDocumentCheckout POST /v1/documents/{document_id}/checkout Acquire Document Checkout Handler
DocumentCheckoutApi getDocumentCheckout GET /v1/documents/{document_id}/checkout Get Document Checkout Handler
DocumentCheckoutApi releaseDocumentCheckout DELETE /v1/documents/{document_id}/checkout Release Document Checkout Handler
DocumentVersionsApi attachCitedAsset POST /v1/document_versions/{version_id}/cited-asset Attach Cited Asset 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 downloadDocumentVersion POST /v1/document_versions/{version_id}/download Download Document Version 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 getDocumentVersionDiff GET /v1/document_versions/{version_id}/diff Get Document Version Diff 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 abortDocumentUpload DELETE /v1/documents/uploads Abort Document Upload Handler
DocumentsApi completeDocumentUpload POST /v1/documents/uploads/complete Complete Document Upload Handler
DocumentsApi createDocument POST /v1/documents Create Document Handler
DocumentsApi createDocumentUpload POST /v1/documents/uploads Create Document Upload Handler
DocumentsApi deleteDocument DELETE /v1/documents/{document_id} Delete Document Handler
DocumentsApi downloadDocument POST /v1/documents/{document_id}/download Download Document Handler
DocumentsApi getDocument GET /v1/documents/{document_id} Get Document Handler
DocumentsApi getDocumentUploadStatus GET /v1/documents/uploads/parts Get Document Upload Status Handler
DocumentsApi ingestDocument POST /v1/documents/ingest Ingest Document Handler
DocumentsApi ingestDocumentVersion POST /v1/documents/{document_id}/ingest Ingest Document Version Handler
DocumentsApi ingestZip POST /v1/documents/ingest-zip Ingest Zip Handler
DocumentsApi listDocuments GET /v1/documents List Documents Handler
DocumentsApi updateDocument PATCH /v1/documents/{document_id} Update Document Handler
DocumentsApi uploadDocumentPart PUT /v1/documents/uploads/parts/{part_number} Upload Document Part 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
InvitesApi updateInvite PATCH /v1/invites/{invite_id} Update Invite Handler
MemoryApi approveMemoryProposal POST /v1/memory/proposals/{chunk_id}/approve Approve Memory Proposal Handler
MemoryApi getMemoryBody GET /v1/memory/body Get Memory Body Handler
MemoryApi listMemoryProposals GET /v1/memory/proposals List Memory Proposals Handler
MemoryApi proposeMemoryChunk POST /v1/memory/proposals Propose Memory Chunk Handler
MemoryApi rejectMemoryProposal POST /v1/memory/proposals/{chunk_id}/reject Reject Memory Proposal Handler
PathPartApprovalsApi getPathPartApproval GET /v1/path-parts/{path_part_id}/approval Get Path Part Approval Handler
PathPartApprovalsApi setPathPartApproval POST /v1/path-parts/{path_part_id}/approval Set Path Part Approval Handler
PathPartsApi appendPathPartEvent POST /v1/path-parts/{path_part_id}/events Append Path Part Event Handler
PathPartsApi bulkRemovePathPartTags DELETE /v1/path-parts/{path_part_id}/tags Bulk Remove Path Part Tags Handler
PathPartsApi checkPathPartAccess GET /v1/path-parts/{path_part_id}/access-check Check Path Part Access 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 listPathPartEvents GET /v1/path-parts/{path_part_id}/events List Path Part Events Handler
PathPartsApi listPathParts GET /v1/path-parts List Path Parts Handler
PathPartsApi reorderPathPart POST /v1/path-parts/{path_part_id}/reorder Reorder Path Part Handler
PathPartsApi setPathPartTags POST /v1/path-parts/{path_part_id}/tags Set Path Part Tags Handler
PathPartsApi transferPathPartOwner PUT /v1/path-parts/{path_part_id}/owner Transfer Path Part Owner Handler
PublicApi listPublicSubscriptions GET /public/subscriptions List Public Subscriptions 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
SkillsApi activateSkillVersion POST /v1/skills/{skill_id}/versions/{version_id}/activate Activate Skill Version Handler
SkillsApi checkinSkill POST /v1/skills/{skill_id}/checkin Checkin Skill Handler
SkillsApi checkoutSkill POST /v1/skills/{skill_id}/checkout Checkout Skill Handler
SkillsApi createSkill POST /v1/skills Create Skill Handler
SkillsApi deleteSkill DELETE /v1/skills/{skill_id} Delete Skill Handler
SkillsApi discardSkillDraft POST /v1/skills/{skill_id}/discard-draft Discard Skill Draft Handler
SkillsApi exportSkill GET /v1/skills/{skill_id}/export Export Skill Handler
SkillsApi getSkill GET /v1/skills/{skill_id} Get Skill Handler
SkillsApi importSkill POST /v1/skills/import Import Skill Handler
SkillsApi listSkillVersions GET /v1/skills/{skill_id}/versions List Skill Versions Handler
SkillsApi listSkills GET /v1/skills List Skills Handler
SkillsApi publishSkillVersion POST /v1/skills/{skill_id}/versions Publish Skill Version Handler
SkillsApi searchSkills POST /v1/skills/search Search Skills Handler
SkillsApi updateSkill PATCH /v1/skills/{skill_id} Update Skill Handler
SubscriptionsApi changeTenantSubscription POST /v1/tenants/{tenant_id}/subscriptions Change Tenant Subscription Handler
SubscriptionsApi getTenantSubscription GET /v1/tenants/{tenant_id}/subscriptions Get Tenant Subscription Handler
SystemJobsApi cancelTemporalWorkflow DELETE /v1/system-jobs/{workflow_id} Cancel Temporal Workflow Handler
SystemJobsApi dvWorkflowRerun POST /v1/system-jobs/document_versions/{workflow_id} Dv Workflow Rerun Handler
SystemJobsApi getDvWorkflow GET /v1/system-jobs/document_versions/{workflow_id} Get Dv Workflow Handler
SystemJobsApi getTemporalWorkflowStatus GET /v1/system-jobs/{workflow_id} Get Temporal Workflow Status Handler
SystemJobsApi getZipIngestionStatus GET /v1/system-jobs/zip-ingestions/{workflow_id} Get Zip Ingestion Status Handler
SystemJobsApi listDvWorkflows GET /v1/system-jobs/document_versions List Dv Workflows 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 getTenantQuotaState GET /v1/tenants/{tenant_id}/quota Get Tenant Quota State Handler
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
TrashApi listTrash GET /v1/trash List Trash Handler
TrashApi permanentlyDeleteTrashItem DELETE /v1/trash/{path_part_id} Permanently Delete Trash Item Handler
TrashApi restoreTrashItem POST /v1/trash/{path_part_id}/restore Restore Trash Item 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 skipOnboarding POST /v1/users/me/onboarding/skip Skip Onboarding Handler
UsersApi updateMe PATCH /v1/users Update Me Handler
UsersApi updateOnboardingCompany PATCH /v1/users/me/onboarding/company Update Onboarding Company Handler
UsersApi updateOnboardingProfile PATCH /v1/users/me/onboarding/profile Update Onboarding Profile Handler
WorkflowDefinitionsApi createWorkflowDefinition POST /v1/workflow-definitions Create Workflow Definition Handler
WorkflowDefinitionsApi createWorkflowRun POST /v1/workflow-definitions/{definition_id}/runs Create Workflow Run 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 instantiateWorkflowTemplate POST /v1/workflow-definitions/{template_id}/instantiate Instantiate Workflow Template 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
WorkflowMemoryApi appendWorkflowMemoryChunk POST /v1/workflow-definitions/{definition_id}/memory/chunks Append Workflow Memory Chunk Handler
WorkflowMemoryApi editWorkflowMemoryChunk PATCH /v1/workflow-definitions/{definition_id}/memory/chunks/{chunk_id} Edit Workflow Memory Chunk Handler
WorkflowMemoryApi forgetWorkflowMemoryChunk DELETE /v1/workflow-definitions/{definition_id}/memory/chunks/{chunk_id} Forget Workflow Memory Chunk Handler
WorkflowMemoryApi getWorkflowMemoryChunk GET /v1/workflow-definitions/{definition_id}/memory/chunks/{chunk_id} Get Workflow Memory Chunk Handler
WorkflowMemoryApi listWorkflowMemoryChunks GET /v1/workflow-definitions/{definition_id}/memory List Workflow Memory Chunks Handler
WorkflowRunsApi cloneWorkflowRun POST /v1/workflow-runs/{run_id}/clone Clone Workflow Run 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 getWorkflowRunsSummary GET /v1/workflow-runs/summary Get Workflow Runs Summary Handler
WorkflowRunsApi listWorkflowRunsForTenant GET /v1/workflow-runs List Workflow Runs For Tenant Handler
WorkflowRunsApi resumeWorkflowRun POST /v1/workflow-runs/{run_id}/resume Resume Workflow Run Handler
WorkflowRunsApi retryWorkflowRun POST /v1/workflow-runs/{run_id}/retry Retry Workflow Run Handler
WorkflowRunsApi setWorkflowRunApproval POST /v1/workflow-runs/{run_id}/approval Set Workflow Run Approval Handler
WorkflowRunsApi startWorkflowRun POST /v1/workflow-runs/{run_id}/start Start Workflow Run Handler
WorkflowRunsApi stopWorkflowRun POST /v1/workflow-runs/{run_id}/stop Stop Workflow Run Handler
WorkflowRunsApi updateWorkflowRun PATCH /v1/workflow-runs/{run_id} Update Workflow Run Handler
WorkflowRunsApi workflowRunCallback POST /v1/workflow-runs/{run_id}/callback Workflow Run Callback Handler

Models

Authorization

Authentication schemes defined for the API:

cookieAuth

  • Type: API key
  • API key parameter name: ks_uat
  • Location:

bearerAuth

  • Type: HTTP Bearer Token authentication

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

About

Knowledge Stack TypeScript/JavaScript SDK (@knowledge-stack/ksapi) — auto-generated from the OpenAPI spec. For most agent use cases, use the MCP server (ks-mcp); this SDK is for admin/write operations and infrastructure tooling.

knowledgestack.ai

Topics

ai-agentsdocument-intelligenceenterprise-ragknowledge-stacknpm-packageopenapiopenapi-generatorragtypescript-sdk

Resources

Readme
MIT license

Security policy

Security policy
Activity
Custom properties

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages