The Docsumo connector lets your AI agent act in each user's Docsumo account. Each user connects their own Docsumo API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 30 tools.
- Tools
- 30
- What they doRead · write · destructive
- 16 · 10 · 416 read10 write4 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Docsumo connection
In AgentKit > Connections, create a Docsumo connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'docsumo'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Docsumo:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'docsumo_account_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "docsumo"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Docsumo:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="docsumo_account_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Docsumo credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooldocsumo_account_getGet your Docsumo account details, monthly document usage and limits, and your active document types.Read-onlyGet Account And Document Types
Get your Docsumo account details, monthly document usage and limits, and your active document types. Returns email, full name, user ID, usage and limits, and document types with their doc_type values. Use this to find doc_type values for docsumo_documents_list and folder creation.
Inputs
This tool takes no inputs.
docsumo_agents_listList the agents (document types and case types) in your Docsumo account.Read-onlyList Agents
List the agents (document types and case types) in your Docsumo account. Returns agents with their IDs, names and kind. Use this to find a casetype_id for the case tools.
Inputs
typestring- Which agents to list: all, doctype or casetype. Defaults to all. Example: casetype.one of
alldoctypecasetype
docsumo_bank_statement_analytics_getGet analytics for a processed bank statement: spending, cash flow and other financial patterns.Read-onlyGet Bank Statement Analytics
Get analytics for a processed bank statement: spending, cash flow and other financial patterns. Returns the analytics as JSON (or a CSV or XLSX export when output is set). Use mode all for the detailed report. Use docsumo_mca_analysis_run for merchant cash advance analysis across statements.
Inputs
doc_idstringrequired- doc_id of a processed bank statement. Example: 40269200cd7443178dea03f8cccea8d4.
modestring- basic for a summary, all for the in-depth report. Defaults to basic. Example: basic.one of
basicall outputstring- Output format. Defaults to json. Example: json.one of
jsoncsvxlsx
docsumo_case_getGet an overview of one case, optionally with its document types, fields, approvals, exports and documents.Read-onlyGet Case
Get an overview of one case, optionally with its document types, fields, approvals, exports and documents. Returns the case's name, stage, assignee, workflow state and the sections requested in include. Use docsumo_cases_list to find case IDs.
Inputs
case_idstringrequired- Case ID, from docsumo_cases_list. Example: case_73b2d9e1f4.
casetype_idstringrequired- Case type ID, from docsumo_agents_list. Example: ct_6a1f0c2e9b.
includestring- Comma-separated sections to include: doctypes, fields, approvals, exports, documents. Example: fields,documents.
docsumo_case_type_getGet the details of a case type: its stages, case fields and settings.Read-onlyGet Case Type
Get the details of a case type: its stages, case fields and settings. Returns the case type with stage IDs and field IDs. Use this to find stage_id and case field IDs for docsumo_case_update and docsumo_cases_list.
Inputs
casetype_idstringrequired- Case type ID, from docsumo_agents_list. Example: ct_6a1f0c2e9b.
docsumo_cases_listList the cases of a case type, filtered by stage, assignee, workflow state or dates, with pagination.Read-onlyList Cases
List the cases of a case type, filtered by stage, assignee, workflow state or dates, with pagination. Returns cases with their IDs, names, stage, assignee, workflow state and timestamps. Use this to find a case_id. Use docsumo_case_get for one case.
Inputs
casetype_idstringrequired- Case type ID, from docsumo_agents_list. Example: ct_6a1f0c2e9b.
assigned_toarray- Only cases assigned to these user IDs. Example: ["usr_51c2"]
created_date_fromstring- Created on or after this date, DD/MM/YYYY. Example: 01/10/2026.
created_date_tostring- Created on or before this date, DD/MM/YYYY. Example: 31/10/2026.
limitinteger- Cases per page, 0 to 100. Defaults to 20. Example: 20.
modified_date_fromstring- Modified on or after this date, DD/MM/YYYY. Example: 01/10/2026.
modified_date_tostring- Modified on or before this date, DD/MM/YYYY. Example: 31/10/2026.
offsetinteger- Cases to skip, for pagination. Defaults to 0. Example: 0.
sort_bystring- Sort field and direction. Defaults to created_date.desc. Example: modified_date.desc.one of
created_date.asccreated_date.descmodified_date.ascmodified_date.desc stage_idarray- Only cases in these stage IDs. Example: ["stg_review"]
workflow_statearray- Only cases in these workflow states. Example: ["completed"]
docsumo_document_data_getGet the data extracted from a document in simplified JSON: key-value fields and tables, whether extracted by Docsumo or corrected by a user.Read-onlyGet Extracted Data
Get the data extracted from a document in simplified JSON: key-value fields and tables, whether extracted by Docsumo or corrected by a user. Returns the document's fields and table rows. Use this once a document is processed. Use docsumo_document_field_update to correct a value.
Inputs
doc_idstringrequired- Docsumo document ID (doc_id), from docsumo_documents_list. Example: 40269200cd7443178dea03f8cccea8d4.
docsumo_document_getGet the metadata of one document, including its pages and page image URLs.Read-onlyGet Document
Get the metadata of one document, including its pages and page image URLs. Returns doc_id, title, type, status, pages with image URLs, and timestamps. Use docsumo_document_data_get for the extracted field values.
Inputs
doc_idstringrequired- Docsumo document ID (doc_id), from docsumo_documents_list. Example: 40269200cd7443178dea03f8cccea8d4.
docsumo_document_review_url_getGenerate a temporary review URL for a document that people without a Docsumo account can open.Read-onlyGet Document Review URL
Generate a temporary review URL for a document that people without a Docsumo account can open. Returns the review URL, with a signed token when signed_url is true. Use this to send a document for external review. Use docsumo_folder_review_url_get for a whole folder.
Inputs
doc_idstringrequired- Docsumo document ID (doc_id), from docsumo_documents_list. Example: 40269200cd7443178dea03f8cccea8d4.
signed_urlboolean- true to include a signed token so external users can open the link for a limited time. Example: true.
docsumo_document_split_files_getGet the files of an auto-split document: the original file, the split files, or both, as presigned S3 URLs or base64.Read-onlyGet Document Split Files
Get the files of an auto-split document: the original file, the split files, or both, as presigned S3 URLs or base64. Returns the requested files. Use docsumo_document_split_info_get for the split metadata.
Inputs
original_doc_idstringrequired- doc_id of the original document before splitting. Example: 40269200cd7443178dea03f8cccea8d4.
file_formatstring- Return files as s3_url, base64 or both. Defaults to s3_url. Example: s3_url.one of
s3_urlbase64both include_filestring- Which files to return. Defaults to original. Example: all.one of
originalsplitall
docsumo_document_split_info_getGet how an auto-split document was divided: the original document and the documents split from it.Read-onlyGet Document Split Info
Get how an auto-split document was divided: the original document and the documents split from it. Returns split metadata, plus file URLs or base64 content when include_file is set. Use docsumo_document_split_files_get when you only need the files.
Inputs
original_doc_idstringrequired- doc_id of the original document before splitting. Example: 40269200cd7443178dea03f8cccea8d4.
file_formatstring- File format when include_file is set: s3_url, base64 or both. Defaults to s3_url. Example: s3_url.one of
s3_urlbase64both include_filestring- Which files to include: original, split or all. Without it only metadata is returned. Example: split.one of
originalsplitall
docsumo_document_types_listList the document types enabled for your Docsumo account.Read-onlyList Enabled Document Types
List the document types enabled for your Docsumo account. Returns the enabled document types. Use docsumo_account_get for usage limits alongside the types.
Inputs
This tool takes no inputs.
docsumo_documents_listList the documents in your Docsumo account, filtered by folder, type, status, title search or creation date, with pagination.Read-onlyList Documents
List the documents in your Docsumo account, filtered by folder, type, status, title search or creation date, with pagination. Returns documents with doc_id, title, type, status, folder and timestamps. Use this to find a doc_id. Use docsumo_document_get for one document's details and docsumo_document_data_get for its extracted data.
Inputs
created_datestring- Creation date filter as operator:YYYY-MM-DD, with gte or lte. Example: gte:2025-03-20.
doc_typestring- Only this document type, a doc_type value from docsumo_account_get. Example: invoice.
folder_idstring- Folder to list. Required when view is folder. Example: cbbe31d3b37a4c2a95518dd7edf4c24e.
limitinteger- Documents to return, up to 20. Example: 20.
offsetinteger- Documents to skip, for pagination. Example: 0.
qstring- Partial-match search on document titles. Example: acme.
sort_bystring- Sort by creation date. Example: created_date.desc.one of
created_date.asccreated_date.desc statusstring- Only documents with this processing status. Example: processed.one of
reviewingprocessederred viewstring- files for documents outside folders, folder for documents in folder_id, all_files for everything. Example: all_files.one of
filesfolderall_files
docsumo_documents_summary_getGet a summary of your documents grouped by document type, with counts per processing status.Read-onlyGet Documents Summary
Get a summary of your documents grouped by document type, with counts per processing status. Returns, per document type, the number of documents in each status. Use this for a quick overview. Use docsumo_documents_list to list documents.
Inputs
This tool takes no inputs.
docsumo_folder_review_url_getGenerate a shareable review link for a folder of documents that people without a Docsumo account can open.Read-onlyGet Folder Review URL
Generate a shareable review link for a folder of documents that people without a Docsumo account can open. Returns the review URL. Use docsumo_document_review_url_get for a single document.
Inputs
folder_idstringrequired- Folder ID. Example: baf65ce1b85c43eca37cdfadb0a621d2.
docsumo_table_data_getGet all rows of a Docsumo database table (used for validation and mapping).Read-onlyGet Database Table Data
Get all rows of a Docsumo database table (used for validation and mapping). Returns the table's headers and rows with their row IDs. Use row IDs and headers with docsumo_table_cell_update.
Inputs
ddidstringrequired- Database table ID. Example: 6650f1a2b3c4d5e6f7a8b9c0.
docsumo_case_updateUpdate a case: move it to a stage, change case fields, reassign it, rename it, or approve or reject a pending review, and optionally run its workflow afterwards.WriteUpdate Case
Update a case: move it to a stage, change case fields, reassign it, rename it, or approve or reject a pending review, and optionally run its workflow afterwards. Returns the updated case. Get stage and field IDs from docsumo_case_type_get.
- Idempotent
Inputs
case_idstringrequired- Case ID, from docsumo_cases_list. Example: case_73b2d9e1f4.
casetype_idstringrequired- Case type ID, from docsumo_agents_list. Example: ct_6a1f0c2e9b.
approvalobject- Human-in-the-loop decision for a pending review: id (approval block ID), is_approved (true approves, false rejects) and an optional reason. Example: {"id": "apr_19d", "is_approved": true, "reason": "Verified"}
assigned_tostring- User ID of the new assignee. Example: usr_51c2.
case_fieldsobject- Case field values to set, keyed by field ID. Example: {"cf_amount": "1250.00"}
case_namestring- New name for the case. Example: Acme loan application.
stage_idstring- Stage to move the case to. Example: stg_approved.
trigger_workflowboolean- true to run the case type's workflow after the update. Defaults to false. Example: false.
docsumo_case_workflow_runRun the workflow of a case type on one case.WriteRun Case Workflow
Run the workflow of a case type on one case. Returns the workflow run result. Use docsumo_case_update with trigger_workflow true to update and run in one call.
Inputs
case_idstringrequired- Case ID, from docsumo_cases_list. Example: case_73b2d9e1f4.
casetype_idstringrequired- Case type ID, from docsumo_agents_list. Example: ct_6a1f0c2e9b.
docsumo_document_field_updateCorrect the value of one extracted field in a document.WriteUpdate Extracted Field
Correct the value of one extracted field in a document. Returns the updated field. Get field IDs from docsumo_document_data_get.
- Idempotent
Inputs
doc_idstringrequired- Docsumo document ID (doc_id), from docsumo_documents_list. Example: 40269200cd7443178dea03f8cccea8d4.
field_idstringrequired- ID of the field to update, from docsumo_document_data_get. Example: 1001.
valuestringrequired- New value for the field. Example: INV-2026-0042.
docsumo_document_review_status_updateStart a review of a document, mark its review complete, or skip review.WriteUpdate Document Review Status
Start a review of a document, mark its review complete, or skip review. Returns the updated review status. Use end to approve a document after checking docsumo_document_data_get.
- Idempotent
Inputs
actionstringrequired- Review action: start, end (complete) or skip. Example: end.one of
startendskip doc_idstringrequired- Docsumo document ID (doc_id), from docsumo_documents_list. Example: 40269200cd7443178dea03f8cccea8d4.
forcedboolean- true to change the status even if the document has validation errors. Example: false.
strictboolean- For end only: true to fail if any data field has a validation error. Example: true.
docsumo_documents_moveMove one or more documents from one folder to another.WriteMove Documents
Move one or more documents from one folder to another. Returns the move result. Get folder IDs from docsumo_documents_list (folder view) or docsumo_folder_create.
- Idempotent
Inputs
dest_folder_idstringrequired- Folder to move the documents to. Example: baf65ce1b85c43eca37cdfadb0a621d2.
doc_idsarrayrequired- doc_ids of the documents to move. Example: ["40269200cd7443178dea03f8cccea8d4"]
source_folder_idstringrequired- Folder the documents are in now. Example: cbbe31d3b37a4c2a95518dd7edf4c24e.
docsumo_folder_createCreate a folder for organizing documents of one document type.WriteCreate Folder
Create a folder for organizing documents of one document type. Returns the created folder with its folder_id. Use docsumo_documents_move to put documents in it.
Inputs
folder_namestringrequired- Name of the new folder. Example: Q4 invoices.
typestringrequired- Document type the folder holds, a doc_type value from docsumo_account_get. Example: invoice.
docsumo_mca_analysis_runRun a merchant cash advance (MCA) account-summary analysis across one or more processed bank statements.WriteRun MCA Analysis
Run a merchant cash advance (MCA) account-summary analysis across one or more processed bank statements. Returns the account summary analysis. Use docsumo_bank_statement_analytics_get for a single statement's analytics.
Inputs
doc_idsarrayrequired- doc_ids of the bank statements to analyze. Example: ["40269200cd7443178dea03f8cccea8d4"]
allow_partialboolean- true to process even if some documents are not in a valid status. Defaults to false. Example: false.
mca_list_db_tablestring- Database table name holding the MCA lender list. Example: mca_lenders.
non_mca_list_db_tablestring- Database table name holding the non-MCA list. Example: non_mca_lenders.
webhookboolean- true to send a webhook notification when processing finishes. Defaults to false. Example: false.
docsumo_table_cell_updateSet the value of one cell in a database table, identified by row ID and column header.WriteUpdate Database Table Cell
Set the value of one cell in a database table, identified by row ID and column header. Returns the update result. Get row IDs and headers from docsumo_table_data_get.
- Idempotent
Inputs
ddidstringrequired- Database table ID. Example: 6650f1a2b3c4d5e6f7a8b9c0.
headerstringrequired- Column header name. Example: CustomerName.
idintegerrequired- Row ID. Example: 1001001.
valuestringrequired- New cell value. Example: Acme Corp.
docsumo_table_row_addAdd an empty row at the end of a database table.WriteAdd Database Table Row
Add an empty row at the end of a database table. It gets the next sequential ID and empty values. Returns the new row. Fill it with docsumo_table_cell_update.
Inputs
ddidstringrequired- Database table ID. Example: 6650f1a2b3c4d5e6f7a8b9c0.
docsumo_cases_deletePermanently delete up to 100 cases of a case type.DestructiveDelete Cases
Permanently delete up to 100 cases of a case type. Returns the deletion result. Get case IDs from docsumo_cases_list.
- Idempotent
Inputs
case_idsarrayrequired- 1 to 100 case IDs to delete. Example: ["case_73b2d9e1f4"]
casetype_idstringrequired- Case type ID, from docsumo_agents_list. Example: ct_6a1f0c2e9b.
docsumo_document_deletePermanently delete a document.DestructiveDelete Document
Permanently delete a document. Returns a confirmation. Get the doc_id from docsumo_documents_list.
- Idempotent
Inputs
doc_idstringrequired- Docsumo document ID (doc_id), from docsumo_documents_list. Example: 40269200cd7443178dea03f8cccea8d4.
docsumo_entity_records_deletePermanently delete up to 1,000 records of an entity, by record ID or by primary key value, with their files, comments and links.DestructiveDelete Entity Records
Permanently delete up to 1,000 records of an entity, by record ID or by primary key value, with their files, comments and links. Returns the deletion result. Send record_ids or primary_key_values.
- Idempotent
Inputs
entity_idstringrequired- Entity ID, from the entity's URL in Docsumo: /tables/<entity_id>. Example: ent_2c9a71.
primary_key_valuesarray- Primary key column values of the records to delete. The entity must have a primary key column. Example: ["INV-1001"]
record_idsarray- IDs of the records to delete, from the record URL /tables/<entity_id>/record/<record_id>. Example: ["rec_8f31"]
docsumo_tables_deletePermanently delete one or more database tables.DestructiveDelete Database Tables
Permanently delete one or more database tables. Returns the deletion result. This cannot be undone.
- Idempotent
Inputs
dd_idsarrayrequired- IDs of the tables to delete. Example: ["6650f1a2b3c4d5e6f7a8b9c0"]
No tools match.