openfilz-sdk-python

API for Document Management System

This Python package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.3.21
Generator version: 7.23.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

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

pip install git+https://github.com/openfilz/openfilz-core.git

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

Then import the package:

import openfilz_sdk

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 openfilz_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import openfilz_sdk
from openfilz_sdk.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): keycloak_auth
configuration = openfilz_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with openfilz_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openfilz_sdk.AIChatApi(api_client)
    plan_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    reorganization_apply_request = openfilz_sdk.ReorganizationApplyRequest() # ReorganizationApplyRequest |  (optional)

    try:
        # Apply a proposed reorganisation plan
        api_response = api_instance.apply(plan_id, reorganization_apply_request=reorganization_apply_request)
        print("The response of AIChatApi->apply:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AIChatApi->apply: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AIChatApi	apply	POST /api/v1/ai/reorganization/{planId}/apply	Apply a proposed reorganisation plan
AIChatApi	chat	POST /api/v1/ai/chat	Chat with AI assistant
AIChatApi	delete_conversation	DELETE /api/v1/ai/conversations/{conversationId}	Delete conversation
AIChatApi	discard	POST /api/v1/ai/reorganization/{planId}/discard	Discard a proposed reorganisation plan
AIChatApi	get3	GET /api/v1/ai/reorganization/{planId}	Get a reorganisation plan proposed by the AI assistant
AIChatApi	get_conversation_history	GET /api/v1/ai/conversations/{conversationId}	Get conversation history
AIChatApi	list_conversations	GET /api/v1/ai/conversations	List conversations
AIChatApi	propose_by_kind	POST /api/v1/ai/reorganization/by-kind	Propose a reorganisation by kind of document — no model involved
AIEmbeddingsApi	backfill1	POST /api/v1/ai/embeddings/backfill	Embed existing documents
AIEmbeddingsApi	backfill_status1	GET /api/v1/ai/embeddings/backfill/{jobId}	Progress of an embedding backfill job
AISettingsApi	delete_settings	DELETE /api/v1/settings/ai	Reset my AI settings
AISettingsApi	get_settings	GET /api/v1/settings/ai	Get my AI settings
AISettingsApi	list_models	POST /api/v1/settings/ai/models	List the provider's chat models
AISettingsApi	save_settings	PUT /api/v1/settings/ai	Save my AI settings
AISettingsApi	test_connection	POST /api/v1/settings/ai/test	Test AI provider connection
DashboardApi	get_dashboard_statistics	GET /api/v1/dashboard/statistics	Get dashboard statistics
DocumentInsightsApi	backfill	POST /api/v1/ai/insights/backfill	Enrich existing documents
DocumentInsightsApi	backfill_status	GET /api/v1/ai/insights/backfill/{jobId}	Progress of a backfill job
DocumentInsightsApi	facets	GET /api/v1/ai/insights/facets	The category and language facets of the library
DocumentInsightsApi	get_insights	GET /api/v1/documents/{documentId}/insights	Get the insights of a document
DocumentInsightsApi	set_category	PATCH /api/v1/documents/{documentId}/insights	Correct the kind of a document
FavoritesApi	add_favorite	POST /api/v1/favorites/{documentId}	Add document to favorites
FavoritesApi	is_favorite	GET /api/v1/favorites/{documentId}/is-favorite	Check favorite status
FavoritesApi	remove_favorite	DELETE /api/v1/favorites/{documentId}	Remove document from favorites
FavoritesApi	toggle_favorite	PUT /api/v1/favorites/{documentId}/toggle	Toggle favorite status
PDFToolsApi	info	GET /api/v1/pdf/{documentId}/info	Describe a stored PDF
PDFToolsApi	merge	POST /api/v1/pdf/merge	Merge PDFs
PDFToolsApi	organize	POST /api/v1/pdf/organize	Reorganise the pages of a PDF
PDFToolsApi	rotate	POST /api/v1/pdf/rotate	Rotate pages
PDFToolsApi	split	POST /api/v1/pdf/split	Split a PDF
SettingsApi	get1	GET /api/v1/settings/ai/preferences	The caller's smart-filing preferences
SettingsApi	get_settings1	GET /api/v1/settings	Get user's settings
SettingsApi	save	PUT /api/v1/settings/ai/preferences	Save the caller's smart-filing preferences
SmartFilingApi	file	POST /api/v1/ai/auto-file	File existing documents on demand
SmartFilingApi	file_inbox	POST /api/v1/ai/auto-file/inbox	File everything lying loose in the caller's Inbox
SmartFilingApi	job	GET /api/v1/ai/auto-file/{jobId}	Progress and outcome of a filing job
SmartFilingApi	jobs	POST /api/v1/ai/auto-file/jobs	Progress and outcome of several filing jobs
SmartFilingApi	last_filing	GET /api/v1/ai/auto-file/document/{documentId}	The latest filing record of a document (the "Filed by OpenFilz" chip)
SmartFilingApi	undo	POST /api/v1/ai/auto-file/{jobId}/undo	Move every document the job filed back where it came from
SmartFilingApi	undo_filing	POST /api/v1/ai/auto-file/filing/{planId}/undo	Move one filed document back (the chip's "Move back")
WorkflowsApi	cancel	POST /api/v1/workflows/instances/{id}/cancel	Cancel a running instance (initiator)
WorkflowsApi	complete	POST /api/v1/workflows/tasks/{id}/complete	Take a transition on a task I am a candidate of
WorkflowsApi	create_definition	POST /api/v1/workflows/definitions	Create a workflow definition (400 with the problem list when invalid)
WorkflowsApi	delete_definition	DELETE /api/v1/workflows/definitions/{id}	Delete a workflow definition (409 while instances are running)
WorkflowsApi	get_definition	GET /api/v1/workflows/definitions/{id}	Get a workflow definition
WorkflowsApi	get_instance	GET /api/v1/workflows/instances/{id}	One instance with its snapshot spec, open task and history
WorkflowsApi	list_definitions	GET /api/v1/workflows/definitions	List workflow definitions
WorkflowsApi	list_instances	GET /api/v1/workflows/instances	List instances (monitor), newest first
WorkflowsApi	my_tasks	GET /api/v1/workflows/tasks/mine	Open tasks I can act on (by e-mail or role)
WorkflowsApi	my_tasks_count	GET /api/v1/workflows/tasks/mine/count	Number of open tasks I can act on (sidebar badge)
WorkflowsApi	reassign	POST /api/v1/workflows/tasks/{id}/reassign	Hand a task to other people (initiator or current candidate)
WorkflowsApi	start	POST /api/v1/workflows/instances	Start a workflow on a document (409 when one is already running)
WorkflowsApi	summary	GET /api/v1/workflows/instances/summary	Counts for the monitor header
WorkflowsApi	update_definition	PUT /api/v1/workflows/definitions/{id}	Update a workflow definition (running instances keep their snapshot)
WorkflowsApi	validate_definition	POST /api/v1/workflows/definitions/validate	Validate a definition without saving it
AuditControllerApi	audit_integrity_status	GET /api/v1/audit/verify/status	Last scheduled audit chain verification
AuditControllerApi	get_audit_trail	GET /api/v1/audit/{id}	Get audit trail for a resource
AuditControllerApi	search_audit_trail	POST /api/v1/audit/search	Search for audit trails
AuditControllerApi	verify_chain	GET /api/v1/audit/verify	Verify audit chain integrity
DocumentControllerApi	create_blank_document	POST /api/v1/documents/create-blank	Create a blank document from template
DocumentControllerApi	delete_document_metadata	DELETE /api/v1/documents/{documentId}/metadata	Delete specific metadata keys
DocumentControllerApi	download_document	GET /api/v1/documents/{documentId}/download	Download a document
DocumentControllerApi	download_for_only_office	GET /api/v1/documents/{documentId}/onlyoffice-download	Download document for OnlyOffice
DocumentControllerApi	download_multiple_documents_as_zip	POST /api/v1/documents/download-multiple	Download multiple documents as ZIP
DocumentControllerApi	get_document_ancestors	GET /api/v1/documents/{documentId}/ancestors	Get document ancestors
DocumentControllerApi	get_document_info	GET /api/v1/documents/{documentId}/info	Get information of a document
DocumentControllerApi	get_document_integrity	GET /api/v1/documents/{documentId}/integrity	Get a document's integrity ledger
DocumentControllerApi	get_document_metadata	POST /api/v1/documents/{documentId}/search/metadata	Search metadata of a document
DocumentControllerApi	get_document_position	GET /api/v1/documents/{documentId}/position	Get document position in folder
DocumentControllerApi	replace_document_content	PUT /api/v1/documents/{documentId}/replace-content	Replace document content
DocumentControllerApi	replace_document_metadata	PUT /api/v1/documents/{documentId}/replace-metadata	Replace document metadata
DocumentControllerApi	search_document_ids_by_metadata	POST /api/v1/documents/search/ids-by-metadata	Search document IDs by metadata
DocumentControllerApi	update_document_metadata	PATCH /api/v1/documents/{documentId}/metadata	Update document metadata
DocumentControllerApi	upload_document	POST /api/v1/documents/upload-multiple	Upload multiple documents
DocumentControllerApi	upload_document1	POST /api/v1/documents/upload	Upload a single document
DocumentSuggestionControllerApi	get_suggestions	GET /api/v1/suggestions
DocumentVersionControllerApi	download_version	GET /api/v1/documents/{documentId}/versions/{versionId}/download	Download a specific document version
DocumentVersionControllerApi	list_versions	GET /api/v1/documents/{documentId}/versions	List document versions
DocumentVersionControllerApi	restore_version	POST /api/v1/documents/{documentId}/versions/{versionId}/restore	Restore a previous document version
ESignApi	cancel1	POST /api/v1/signatures/{id}/cancel	Cancel a non-terminal envelope
ESignApi	cloud_subscription	GET /api/v1/signatures/cloud-subscription	Cloud Signing subscription and month-to-date usage (openfilz-cloud seal provider only)
ESignApi	create	POST /api/v1/signatures	Create an envelope (sent immediately unless send=false)
ESignApi	events	GET /api/v1/signatures/{id}/events	Audit trail of one of my envelopes
ESignApi	get2	GET /api/v1/signatures/{id}	Get one of my envelopes (recipients + fields)
ESignApi	list_sent	GET /api/v1/signatures	List envelopes I sent for signature
ESignApi	list_to_sign	GET /api/v1/signatures/to-sign	List envelopes waiting for my signature
ESignApi	resend	POST /api/v1/signatures/{id}/recipients/{recipientId}/resend	Resend the signing link to a recipient (new token, previous one revoked)
ESignApi	send	POST /api/v1/signatures/{id}/send	Send a DRAFT envelope
ESignApi	signed_document	GET /api/v1/signatures/{id}/signed-document	Download the sealed PDF of a completed envelope
ESignTemplatesApi	create1	POST /api/v1/signature-templates	Create a template
ESignTemplatesApi	delete	DELETE /api/v1/signature-templates/{id}	Delete a template
ESignTemplatesApi	get	GET /api/v1/signature-templates/{id}	Get a template
ESignTemplatesApi	instantiate	POST /api/v1/signature-templates/{id}/envelopes	Create (and send) an envelope from a template
ESignTemplatesApi	list	GET /api/v1/signature-templates	List my templates
ESignTemplatesApi	update	PUT /api/v1/signature-templates/{id}	Update a template
ESignPublicApi	decline	POST /api/v1/public/signatures/decline	Decline to sign (voids the envelope)
ESignPublicApi	document	GET /api/v1/public/signatures/document	Stream the source PDF for signing
ESignPublicApi	mark_viewed	POST /api/v1/public/signatures/viewed	Record that the recipient opened the document
ESignPublicApi	request_otp	POST /api/v1/public/signatures/otp/request	Send a one-time access code to the recipient (EMAIL_OTP / SMS_OTP)
ESignPublicApi	sign	POST /api/v1/public/signatures/sign	Submit the recipient's fields and sign
ESignPublicApi	verify_otp	POST /api/v1/public/signatures/otp/verify	Verify the one-time access code
ESignPublicApi	view	GET /api/v1/public/signatures	Resolve a signing token to its envelope view
FileControllerApi	copy_files	POST /api/v1/files/copy	Copy files
FileControllerApi	delete_files	DELETE /api/v1/files	Delete files
FileControllerApi	move_files	POST /api/v1/files/move	Move files
FileControllerApi	rename_file	PUT /api/v1/files/{fileId}/rename	Rename a file
FolderControllerApi	copy_folders	POST /api/v1/folders/copy	Copy folders
FolderControllerApi	count_folder_elements	GET /api/v1/folders/count	Count files and subfolders contained in a given folder - return 0 if empty or not exists
FolderControllerApi	create_folder	POST /api/v1/folders	Create a new folder
FolderControllerApi	delete_folders	DELETE /api/v1/folders	Delete folders
FolderControllerApi	list_folder	GET /api/v1/folders/list	List files and subfolders contained in a given folder
FolderControllerApi	move_folders	POST /api/v1/folders/move	Move folders
FolderControllerApi	rename_folder	PUT /api/v1/folders/{folderId}/rename	Rename a folder
McpDiscoveryControllerApi	authorization_server_metadata	GET /.well-known/oauth-authorization-server
McpDiscoveryControllerApi	protected_resource_metadata	GET /.well-known/oauth-protected-resource
TusControllerApi	cancel_upload	DELETE /api/v1/tus/{uploadId}	Cancel upload
TusControllerApi	create_upload	POST /api/v1/tus	Create new TUS upload
TusControllerApi	finalize_upload	POST /api/v1/tus/{uploadId}/finalize	Finalize upload
TusControllerApi	get_config	GET /api/v1/tus/config	Get TUS configuration
TusControllerApi	get_upload_info	GET /api/v1/tus/{uploadId}/info	Get upload information
TusControllerApi	get_upload_offset	HEAD /api/v1/tus/{uploadId}	Get upload progress
TusControllerApi	is_upload_complete	GET /api/v1/tus/{uploadId}/complete	Check upload completion
TusControllerApi	options	OPTIONS /api/v1/tus	TUS capability discovery
TusControllerApi	upload_chunk	PATCH /api/v1/tus/{uploadId}	Upload chunk

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

keycloak_auth

Type: Bearer authentication (JWT)

Author

Release files for openfilz-sdk 1.3.21

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openfilz-sdk 1.3.21
File	Size	Uploaded
openfilz_sdk-1.3.21.tar.gz	147.8 kB	Sep 17, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for openfilz-sdk 1.3.21
File	Interpreter	ABI	Platform	Reset
openfilz_sdk-1.3.21-py3-none-any.whl 295.5 kB Sep 17, 2026	Python 3	none	any	Details

Total release size: 443.3 kB

Release files / openfilz_sdk-1.3.21.tar.gz

Download URL	openfilz_sdk-1.3.21.tar.gz
Size	147.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`db3a079b2109f3a55a3ded57c5f19c374d40a8200c0bc18d2c5204a5470345c4`
BLAKE2b-256 checksum How to use checksums	`4e384441074778529e6a9529d074c2df14d0462a1f2d8ec983a1779bd3a3c578`
Upload date	Sep 17, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.7`

Release files / openfilz_sdk-1.3.21-py3-none-any.whl

Download URL	openfilz_sdk-1.3.21-py3-none-any.whl
Size	295.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`621adc67fecc3d86e4e95826ece924e6e1864ddcdd4f061ecfd8defb185c7c36`
BLAKE2b-256 checksum How to use checksums	`f5dacd651fffaa418c2ef752d935ca5dd022657516a610c42b165e8da76f2bac`
Upload date	Sep 17, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.7`