Skip to content

knowledgestack/ks-sdk-python

BranchesTags

Repository files navigation

ksapi — Knowledge Stack Python SDK

Focus on agents. We handle document intelligence.

Python client for the Knowledge Stack API.

PyPI License: MIT Discord

Install

pip install ksapi
# or
uv pip install ksapi

Related repos

For most agent use cases, talk to Knowledge Stack via the MCP server, not this SDK directly. This SDK is the right choice when you need admin / write operations or are building infrastructure (ingestion pipelines, schedulers, migration tools).

How this package is maintained

This package is generated from the Knowledge Stack OpenAPI specification by OpenAPI Generator. API-shape issues belong upstream in ks-backend; client-side bugs (import problems, wrapper behavior, release packaging) belong here.

Below this line is the auto-generated reference content.

ksapi

Knowledge Stack backend API for authentication and knowledge management

This Python package 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.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import ksapi

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ksapi

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ksapi
from ksapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = ksapi.Configuration(
    host = "http://localhost:8000"
)



# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.FeedbackApi(api_client)
    feedback_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    authorization = 'authorization_example' # str |  (optional)
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # Delete Feedback Handler
        api_instance.delete_feedback(feedback_id, authorization=authorization, ks_uat=ks_uat)
    except ApiException as e:
        print("Exception when calling FeedbackApi->delete_feedback: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
FeedbackApi delete_feedback DELETE /v1/feedback/{feedback_id} Delete Feedback Handler
FeedbackApi list_feedback GET /v1/feedback List Feedback Handler
FeedbackApi submit_feedback POST /v1/feedback Submit Feedback Handler
ThreadMessagesApi create_generated_document POST /v1/thread-messages/{thread_message_id}/generated-documents Create Generated Document Handler
ThreadMessagesApi create_thread_message POST /v1/threads/{thread_id}/messages Create Thread Message Handler
ThreadMessagesApi get_thread_message GET /v1/threads/{thread_id}/messages/{message_id} Get Thread Message Handler
ThreadMessagesApi list_thread_messages GET /v1/threads/{thread_id}/messages List Thread Messages Handler
ThreadsApi create_thread POST /v1/threads Create Thread Handler
ThreadsApi delete_thread DELETE /v1/threads/{thread_id} Delete Thread Handler
ThreadsApi get_thread GET /v1/threads/{thread_id} Get Thread Handler
ThreadsApi list_threads GET /v1/threads List Threads Handler
ThreadsApi send_user_message POST /v1/threads/{thread_id}/user_message Send User Message Handler
ThreadsApi stream_thread GET /v1/threads/{thread_id}/stream Stream Thread Handler
ThreadsApi update_thread PATCH /v1/threads/{thread_id} Update Thread Handler
WorkflowDefinitionsApi create_workflow_definition POST /v1/workflow-definitions Create Workflow Definition Handler
WorkflowDefinitionsApi delete_workflow_definition DELETE /v1/workflow-definitions/{definition_id} Delete Workflow Definition Handler
WorkflowDefinitionsApi get_workflow_definition GET /v1/workflow-definitions/{definition_id} Get Workflow Definition Handler
WorkflowDefinitionsApi invoke_workflow POST /v1/workflow-definitions/{definition_id}/invoke Invoke Workflow Handler
WorkflowDefinitionsApi list_workflow_definitions GET /v1/workflow-definitions List Workflow Definitions Handler
WorkflowDefinitionsApi list_workflow_runs GET /v1/workflow-definitions/{definition_id}/runs List Workflow Runs Handler
WorkflowDefinitionsApi update_workflow_definition PUT /v1/workflow-definitions/{definition_id} Update Workflow Definition Handler
WorkflowRunsApi delete_workflow_run DELETE /v1/workflow-runs/{run_id} Delete Workflow Run Handler
WorkflowRunsApi get_workflow_run GET /v1/workflow-runs/{run_id} Get Workflow Run Handler
WorkflowRunsApi workflow_run_callback POST /v1/workflow-runs/{run_id}/callback Workflow Run Callback Handler
ApiKeysApi create_api_key POST /v1/api-keys Create Api Key Handler
ApiKeysApi delete_api_key DELETE /v1/api-keys/{api_key_id} Delete Api Key Handler
ApiKeysApi get_api_key GET /v1/api-keys/{api_key_id} Get Api Key Handler
ApiKeysApi list_api_keys GET /v1/api-keys List Api Keys Handler
AuthApi create_password_user POST /v1/auth/pw/user Create Password User Handler
AuthApi fanwei_directory_sync POST /v1/auth/sso/{tenant_id}/directory_sync Directory Sync Handler
AuthApi fanwei_directory_sync_0 POST /v1/auth/sso/{tenant_id}/directory_sync Directory Sync Handler
AuthApi initiate_sso POST /v1/auth/sso/initiate Initiate Sso Handler
AuthApi oauth2_callback GET /v1/auth/sso/oauth2/callback Oauth2 Callback Handler
AuthApi pw_email_verification POST /v1/auth/pw/email_verification Pw Email Verification Handler
AuthApi pw_signin POST /v1/auth/pw/signin Signin Handler
AuthApi refresh_uat POST /v1/auth/uat Refresh Uat Handler
AuthApi reset_password POST /v1/auth/pw/reset Reset Password Handler
AuthApi reset_password_with_token POST /v1/auth/pw/reset_with_token Reset Password With Token Handler
AuthApi send_pw_reset_email POST /v1/auth/pw/send_reset_email Send Pw Reset Email Handler
AuthApi signout POST /v1/auth/signout Signout Handler
AuthApi sso_signin GET /v1/auth/sso/{tenant_id}/signin Sso Login Handler
BillingApi admin_clear_enterprise_override DELETE /v1/billing/admin/tenants/{tenant_id}/overrides Admin Clear Enterprise Override Handler
BillingApi admin_set_enterprise_override PUT /v1/billing/admin/tenants/{tenant_id}/overrides Admin Set Enterprise Override Handler
BillingApi cancel_tenant_subscription POST /v1/billing/subscription/cancel Cancel Tenant Subscription Handler
BillingApi create_billing_checkout_session POST /v1/billing/checkout-session Create Billing Checkout Session Handler
BillingApi create_billing_portal_session POST /v1/billing/portal-session Create Billing Portal Session Handler
BillingApi get_current_user_usage GET /v1/billing/usage/me Get Current User Usage Handler
BillingApi get_tenant_subscription GET /v1/billing/subscription Get Tenant Subscription Handler
BillingApi get_tenant_usage GET /v1/billing/usage Get Tenant Usage Handler
BillingApi list_billing_plans GET /v1/billing/plans List Billing Plans Handler
BillingApi resume_tenant_subscription POST /v1/billing/subscription/resume Resume Tenant Subscription Handler
BillingApi set_billing_contact PUT /v1/billing/billing-contact Set Billing Contact Handler
ChunkLineagesApi create_chunk_lineage POST /v1/chunk-lineages Create Chunk Lineage Handler
ChunkLineagesApi delete_chunk_lineage DELETE /v1/chunk-lineages Delete Chunk Lineage Handler
ChunkLineagesApi get_chunk_lineage GET /v1/chunk-lineages/{chunk_id} Get Chunk Lineage Handler
ChunksApi create_chunk POST /v1/chunks Create Chunk Handler
ChunksApi delete_chunk DELETE /v1/chunks/{chunk_id} Delete Chunk Handler
ChunksApi get_chunk GET /v1/chunks/{chunk_id} Get Chunk Handler
ChunksApi get_chunk_neighbors GET /v1/chunks/{chunk_id}/neighbors Get Chunk Neighbors Handler
ChunksApi get_chunks_bulk GET /v1/chunks/bulk Get Chunks Bulk Handler
ChunksApi get_version_chunk_ids GET /v1/chunks/version-chunk-ids Get Version Chunk Ids Handler
ChunksApi search_chunks POST /v1/chunks/search Search Chunks Handler
ChunksApi update_chunk_content PATCH /v1/chunks/{chunk_id}/content Update Chunk Content Handler
ChunksApi update_chunk_metadata PATCH /v1/chunks/{chunk_id} Update Chunk Metadata Handler
DefaultApi health_check GET /healthz Health Check Handler
DefaultApi hello GET / Root Handler
DocumentVersionsApi clear_document_version_contents DELETE /v1/document_versions/{version_id}/contents Clear Document Version Contents Handler
DocumentVersionsApi create_document_version POST /v1/documents/{document_id}/versions Create Document Version Handler
DocumentVersionsApi delete_document_version DELETE /v1/document_versions/{version_id} Delete Document Version Handler
DocumentVersionsApi document_version_action POST /v1/document_versions/{version_id} Document Version Action Handler
DocumentVersionsApi get_document_version GET /v1/document_versions/{version_id} Get Document Version Handler
DocumentVersionsApi get_document_version_contents GET /v1/document_versions/{version_id}/contents Get Document Version Contents Handler
DocumentVersionsApi list_document_versions GET /v1/document_versions List Document Versions Handler
DocumentVersionsApi update_document_version_metadata PATCH /v1/document_versions/{version_id}/metadata Update Document Version Metadata Handler
DocumentsApi create_document POST /v1/documents Create Document Handler
DocumentsApi delete_document DELETE /v1/documents/{document_id} Delete Document Handler
DocumentsApi get_document GET /v1/documents/{document_id} Get Document Handler
DocumentsApi ingest_document POST /v1/documents/ingest Ingest Document Handler
DocumentsApi ingest_document_version POST /v1/documents/{document_id}/ingest Ingest Document Version Handler
DocumentsApi list_documents GET /v1/documents List Documents Handler
DocumentsApi update_document PATCH /v1/documents/{document_id} Update Document Handler
FeaturesApi get_features GET /v1/features Get Features Handler
FoldersApi create_folder POST /v1/folders Create Folder Handler
FoldersApi delete_folder DELETE /v1/folders/{folder_id} Delete Folder Handler
FoldersApi folder_action POST /v1/folders/{folder_id} Folder Action Handler
FoldersApi get_folder GET /v1/folders/{folder_id} Get Folder Handler
FoldersApi list_folder_contents GET /v1/folders/{folder_id}/contents List Folder Contents Handler
FoldersApi list_folders GET /v1/folders List Folders Handler
FoldersApi search_items GET /v1/folders/search Search Items Handler
FoldersApi update_folder PATCH /v1/folders/{folder_id} Update Folder Handler
InvitesApi accept_invite POST /v1/invites/{invite_id}/accept Accept Invite
InvitesApi create_invite POST /v1/invites Create Invite
InvitesApi delete_invite DELETE /v1/invites/{invite_id} Delete Invite
InvitesApi list_invites GET /v1/invites List Invites Handler
PathPartsApi bulk_add_path_part_tags POST /v1/path-parts/{path_part_id}/tags Bulk Add Path Part Tags Handler
PathPartsApi bulk_remove_path_part_tags DELETE /v1/path-parts/{path_part_id}/tags Bulk Remove Path Part Tags Handler
PathPartsApi get_path_part GET /v1/path-parts/{path_part_id} Get Path Part Handler
PathPartsApi get_path_part_ancestry GET /v1/path-parts/{path_part_id}/ancestry Get Path Part Ancestry Handler
PathPartsApi get_path_part_subtree_chunks GET /v1/path-parts/{path_part_id}/subtree_chunks Get Path Part Subtree Chunks Handler
PathPartsApi get_path_part_tags GET /v1/path-parts/{path_part_id}/tags Get Path Part Tags Handler
PathPartsApi list_path_parts GET /v1/path-parts List Path Parts Handler
SectionsApi create_section POST /v1/sections Create Section Handler
SectionsApi delete_section DELETE /v1/sections/{section_id} Delete Section Handler
SectionsApi dissolve_section POST /v1/sections/{section_id}/dissolve Dissolve Section Handler
SectionsApi get_section GET /v1/sections/{section_id} Get Section Handler
SectionsApi get_sections_bulk GET /v1/sections/bulk Get Sections Bulk Handler
SectionsApi update_section PATCH /v1/sections/{section_id} Update Section Handler
TagsApi create_tag POST /v1/tags Create Tag Handler
TagsApi delete_tag DELETE /v1/tags/{tag_id} Delete Tag Handler
TagsApi get_tag GET /v1/tags/{tag_id} Get Tag Handler
TagsApi list_tags GET /v1/tags List Tags Handler
TagsApi update_tag PATCH /v1/tags/{tag_id} Update Tag Handler
TenantGroupsApi add_group_member POST /v1/tenant-groups/{group_id}/members Add Group Member Handler
TenantGroupsApi create_group_permission POST /v1/tenant-groups/{group_id}/permissions Create Group Permission Handler
TenantGroupsApi create_tenant_group POST /v1/tenant-groups Create Tenant Group Handler
TenantGroupsApi delete_group_permission DELETE /v1/tenant-groups/{group_id}/permissions/{permission_id} Delete Group Permission Handler
TenantGroupsApi delete_tenant_group DELETE /v1/tenant-groups/{group_id} Delete Tenant Group Handler
TenantGroupsApi get_tenant_group GET /v1/tenant-groups/{group_id} Get Tenant Group Handler
TenantGroupsApi list_group_members GET /v1/tenant-groups/{group_id}/members List Group Members Handler
TenantGroupsApi list_group_permissions GET /v1/tenant-groups/{group_id}/permissions List Group Permissions Handler
TenantGroupsApi list_my_groups GET /v1/tenant-groups/my-group List My Groups Handler
TenantGroupsApi list_tenant_groups GET /v1/tenant-groups List Tenant Groups Handler
TenantGroupsApi remove_group_member DELETE /v1/tenant-groups/{group_id}/members/{user_id} Remove Group Member Handler
TenantGroupsApi update_group_permission PATCH /v1/tenant-groups/{group_id}/permissions/{permission_id} Update Group Permission Handler
TenantGroupsApi update_tenant_group PATCH /v1/tenant-groups/{group_id} Update Tenant Group Handler
TenantsApi activate_tenant_user POST /v1/tenants/{tenant_id}/users/{user_id}/activate Activate Tenant User Handler
TenantsApi deactivate_tenant_user POST /v1/tenants/{tenant_id}/users/{user_id}/deactivate Deactivate Tenant User Handler
TenantsApi delete_tenant DELETE /v1/tenants/{tenant_id} Delete Tenant
TenantsApi delete_tenant_logo DELETE /v1/tenants/{tenant_id}/branding/logo Delete Tenant Logo
TenantsApi delete_tenant_user DELETE /v1/tenants/{tenant_id}/users/{user_id} Delete Tenant User Handler
TenantsApi get_tenant GET /v1/tenants/{tenant_id} Get Tenant
TenantsApi list_tenant_users GET /v1/tenants/{tenant_id}/users List Tenant Users
TenantsApi list_tenants GET /v1/tenants List Tenants
TenantsApi update_tenant PATCH /v1/tenants/{tenant_id} Update Tenant
TenantsApi update_tenant_user PATCH /v1/tenants/{tenant_id}/users/{user_id} Update Tenant User
TenantsApi upload_tenant_logo POST /v1/tenants/{tenant_id}/branding/logo Upload Tenant Logo
UserPermissionsApi create_user_permission POST /v1/user-permissions Create User Permission Handler
UserPermissionsApi delete_user_permission DELETE /v1/user-permissions/{permission_id} Delete User Permission Handler
UserPermissionsApi list_user_permissions GET /v1/user-permissions List User Permissions Handler
UserPermissionsApi update_user_permission PATCH /v1/user-permissions/{permission_id} Update User Permission Handler
UsersApi get_me GET /v1/users/me Get Me Handler
UsersApi update_me PATCH /v1/users Update Me Handler
WorkflowsApi cancel_temporal_workflow DELETE /v1/workflows/{workflow_id} Cancel Temporal Workflow Handler
WorkflowsApi dv_workflow_rerun POST /v1/workflows/document_versions/{workflow_id} Dv Workflow Rerun Handler
WorkflowsApi get_dv_workflow GET /v1/workflows/document_versions/{workflow_id} Get Dv Workflow Handler
WorkflowsApi get_temporal_workflow_status GET /v1/workflows/{workflow_id} Get Temporal Workflow Status Handler
WorkflowsApi list_dv_workflows GET /v1/workflows/document_versions List Dv Workflows Handler

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

About

Knowledge Stack Python SDK (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

openapi python-sdk ai-agents rag openapi-generator document-intelligence enterprise-rag knowledge-stack

Resources

Readme

License

MIT license

Security policy

Security policy
Activity
Custom properties

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages