productivity
SignNow CLI for AI Agents
Use the SignNow CLI from KosmoKrator to call SignNow tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.SignNow CLI Setup
SignNow can be configured headlessly with `kosmokrator integrations:configure signnow`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure signnow --set access_token="$SIGNNOW_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor signnow --json
kosmokrator integrations:status --json Credentials
Authentication type: Manual OAuth token oauth2_manual_token. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
access_token | SIGNNOW_ACCESS_TOKEN | Secret secret | yes | Access Token |
url | SIGNNOW_URL | URL url | no | API Base URL |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call signnow.signnow_list_documents '{"page":1,"per_page":1}' --json kosmo integrations:signnow signnow_list_documents '{"page":1,"per_page":1}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs signnow --json
kosmo integrations:docs signnow.signnow_list_documents --json
kosmo integrations:schema signnow.signnow_list_documents --json
kosmo integrations:search "SignNow" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
signnow.signnow_list_documents
List documents accessible to the authenticated SignNow user. Returns document IDs, names, and status. Supports pagination with page and per_page parameters.
read - Parameters
- page, per_page
kosmo integrations:call signnow.signnow_list_documents '{"page":1,"per_page":1}' --json kosmo integrations:signnow signnow_list_documents '{"page":1,"per_page":1}' --json signnow.signnow_get_document
Get full details for a specific SignNow document by ID, including fields, signers, and document status.
read - Parameters
- document_id
kosmo integrations:call signnow.signnow_get_document '{"document_id":"example_document_id"}' --json kosmo integrations:signnow signnow_get_document '{"document_id":"example_document_id"}' --json signnow.signnow_create_document
Upload a file to SignNow to create a new document. The file must be a PDF. Returns the new document ID and details.
write - Parameters
- file_path, file_name
kosmo integrations:call signnow.signnow_create_document '{"file_path":"example_file_path","file_name":"example_file_name"}' --json kosmo integrations:signnow signnow_create_document '{"file_path":"example_file_path","file_name":"example_file_name"}' --json signnow.signnow_update_document
Update a SignNow document with official document fields such as fields, texts, checks, or document metadata.
write - Parameters
- document_id, payload
kosmo integrations:call signnow.signnow_update_document '{"document_id":"example_document_id","payload":"example_payload"}' --json kosmo integrations:signnow signnow_update_document '{"document_id":"example_document_id","payload":"example_payload"}' --json signnow.signnow_delete_document
Delete a SignNow document by ID.
write - Parameters
- document_id
kosmo integrations:call signnow.signnow_delete_document '{"document_id":"example_document_id"}' --json kosmo integrations:signnow signnow_delete_document '{"document_id":"example_document_id"}' --json signnow.signnow_download_document
Download a SignNow document and return the response body when the API returns binary or text content.
read - Parameters
- document_id, type
kosmo integrations:call signnow.signnow_download_document '{"document_id":"example_document_id","type":"example_type"}' --json kosmo integrations:signnow signnow_download_document '{"document_id":"example_document_id","type":"example_type"}' --json signnow.signnow_get_document_download_link
Get a temporary download link for a SignNow document.
read - Parameters
- document_id, type
kosmo integrations:call signnow.signnow_get_document_download_link '{"document_id":"example_document_id","type":"example_type"}' --json kosmo integrations:signnow signnow_get_document_download_link '{"document_id":"example_document_id","type":"example_type"}' --json signnow.signnow_get_document_history
Get event history for a SignNow document.
read - Parameters
- document_id
kosmo integrations:call signnow.signnow_get_document_history '{"document_id":"example_document_id"}' --json kosmo integrations:signnow signnow_get_document_history '{"document_id":"example_document_id"}' --json signnow.signnow_merge_documents
Merge multiple SignNow documents into a new document.
write - Parameters
- document_ids, name, payload
kosmo integrations:call signnow.signnow_merge_documents '{"document_ids":"example_document_ids","name":"example_name","payload":"example_payload"}' --json kosmo integrations:signnow signnow_merge_documents '{"document_ids":"example_document_ids","name":"example_name","payload":"example_payload"}' --json signnow.signnow_list_templates
List document templates available in the authenticated SignNow account. Templates can be used to create new documents with pre-defined fields.
read - Parameters
- none
kosmo integrations:call signnow.signnow_list_templates '{}' --json kosmo integrations:signnow signnow_list_templates '{}' --json signnow.signnow_create_template
Create a SignNow template from an existing document.
write - Parameters
- document_id, template_name, remove_original_document
kosmo integrations:call signnow.signnow_create_template '{"document_id":"example_document_id","template_name":"example_template_name","remove_original_document":true}' --json kosmo integrations:signnow signnow_create_template '{"document_id":"example_document_id","template_name":"example_template_name","remove_original_document":true}' --json signnow.signnow_duplicate_template
Duplicate a SignNow template into a new document.
write - Parameters
- template_id, document_name
kosmo integrations:call signnow.signnow_duplicate_template '{"template_id":"example_template_id","document_name":"example_document_name"}' --json kosmo integrations:signnow signnow_duplicate_template '{"template_id":"example_template_id","document_name":"example_document_name"}' --json signnow.signnow_delete_template
Delete a SignNow template by ID.
write - Parameters
- template_id
kosmo integrations:call signnow.signnow_delete_template '{"template_id":"example_template_id"}' --json kosmo integrations:signnow signnow_delete_template '{"template_id":"example_template_id"}' --json signnow.signnow_send_invite
Send a signing invitation for a SignNow document. The recipient will receive an email with a link to review and sign the document.
write - Parameters
- document_id, to, from, subject, message, payload
kosmo integrations:call signnow.signnow_send_invite '{"document_id":"example_document_id","to":"example_to","from":"example_from","subject":"example_subject","message":"example_message","payload":"example_payload"}' --json kosmo integrations:signnow signnow_send_invite '{"document_id":"example_document_id","to":"example_to","from":"example_from","subject":"example_subject","message":"example_message","payload":"example_payload"}' --json signnow.signnow_send_freeform_invite
Send a SignNow invite using a full official payload for advanced recipient, role, routing, and reminder setups.
write - Parameters
- document_id, payload
kosmo integrations:call signnow.signnow_send_freeform_invite '{"document_id":"example_document_id","payload":"example_payload"}' --json kosmo integrations:signnow signnow_send_freeform_invite '{"document_id":"example_document_id","payload":"example_payload"}' --json signnow.signnow_cancel_field_invite
Cancel active field invite signing sessions for a SignNow document.
write - Parameters
- document_id
kosmo integrations:call signnow.signnow_cancel_field_invite '{"document_id":"example_document_id"}' --json kosmo integrations:signnow signnow_cancel_field_invite '{"document_id":"example_document_id"}' --json signnow.signnow_cancel_freeform_invite
Cancel a SignNow free-form invite by invite ID.
write - Parameters
- invite_id
kosmo integrations:call signnow.signnow_cancel_freeform_invite '{"invite_id":"example_invite_id"}' --json kosmo integrations:signnow signnow_cancel_freeform_invite '{"invite_id":"example_invite_id"}' --json signnow.signnow_get_current_user
Get the authenticated SignNow user profile, including name, email, and account details.
read - Parameters
- none
kosmo integrations:call signnow.signnow_get_current_user '{}' --json kosmo integrations:signnow signnow_get_current_user '{}' --json signnow.signnow_api_get
Call a relative SignNow API GET path, such as "/document". Absolute URLs are rejected.
read - Parameters
- path, params
kosmo integrations:call signnow.signnow_api_get '{"path":"example_path","params":"example_params"}' --json kosmo integrations:signnow signnow_api_get '{"path":"example_path","params":"example_params"}' --json signnow.signnow_api_post
Call a relative SignNow API POST path. Absolute URLs are rejected.
write - Parameters
- path, payload
kosmo integrations:call signnow.signnow_api_post '{"path":"example_path","payload":"example_payload"}' --json kosmo integrations:signnow signnow_api_post '{"path":"example_path","payload":"example_payload"}' --json signnow.signnow_api_put
Call a relative SignNow API PUT path. Absolute URLs are rejected.
write - Parameters
- path, payload
kosmo integrations:call signnow.signnow_api_put '{"path":"example_path","payload":"example_payload"}' --json kosmo integrations:signnow signnow_api_put '{"path":"example_path","payload":"example_payload"}' --json signnow.signnow_api_delete
Call a relative SignNow API DELETE path. Absolute URLs are rejected.
write - Parameters
- path, payload
kosmo integrations:call signnow.signnow_api_delete '{"path":"example_path","payload":"example_payload"}' --json kosmo integrations:signnow signnow_api_delete '{"path":"example_path","payload":"example_payload"}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
signnow.signnow_list_documents 2 parameters
kosmo integrations:schema signnow.signnow_list_documents --json | Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | Page number for pagination (1-based). Default: 1. |
per_page | integer | no | Number of documents per page. Default: 20. |
signnow.signnow_get_document 1 parameters
kosmo integrations:schema signnow.signnow_get_document --json | Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | yes | The unique document identifier. |
signnow.signnow_create_document 2 parameters
kosmo integrations:schema signnow.signnow_create_document --json | Parameter | Type | Required | Description |
|---|---|---|---|
file_path | string | yes | Absolute path to the PDF file to upload. |
file_name | string | no | Name for the uploaded file. Defaults to the basename of file_path. |
signnow.signnow_update_document 2 parameters
kosmo integrations:schema signnow.signnow_update_document --json | Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | yes | Document ID. |
payload | object | yes | Official document update payload. |
signnow.signnow_delete_document 1 parameters
kosmo integrations:schema signnow.signnow_delete_document --json | Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | yes | Document ID. |
signnow.signnow_download_document 2 parameters
kosmo integrations:schema signnow.signnow_download_document --json | Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | yes | Document ID. |
type | string | no | Optional download type accepted by SignNow. |
signnow.signnow_get_document_download_link 2 parameters
kosmo integrations:schema signnow.signnow_get_document_download_link --json | Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | yes | Document ID. |
type | string | no | Optional download type accepted by SignNow. |
signnow.signnow_get_document_history 1 parameters
kosmo integrations:schema signnow.signnow_get_document_history --json | Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | yes | Document ID. |
signnow.signnow_merge_documents 3 parameters
kosmo integrations:schema signnow.signnow_merge_documents --json | Parameter | Type | Required | Description |
|---|---|---|---|
document_ids | array | yes | Document IDs to merge. |
name | string | no | Merged document name. |
payload | object | no | Additional official merge fields. |
signnow.signnow_list_templates 0 parameters
kosmo integrations:schema signnow.signnow_list_templates --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
signnow.signnow_create_template 3 parameters
kosmo integrations:schema signnow.signnow_create_template --json | Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | yes | Source document ID. |
template_name | string | no | Optional template name. |
remove_original_document | boolean | no | Remove the source document after creating the template. |
signnow.signnow_duplicate_template 2 parameters
kosmo integrations:schema signnow.signnow_duplicate_template --json | Parameter | Type | Required | Description |
|---|---|---|---|
template_id | string | yes | Template ID. |
document_name | string | no | Optional name for the duplicated document. |
signnow.signnow_delete_template 1 parameters
kosmo integrations:schema signnow.signnow_delete_template --json | Parameter | Type | Required | Description |
|---|---|---|---|
template_id | string | yes | Template ID. |
signnow.signnow_send_invite 6 parameters
kosmo integrations:schema signnow.signnow_send_invite --json | Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | yes | The unique document identifier to send an invite for. |
to | string | yes | Recipient email address for the signing invite. |
from | string | yes | Sender email address (must be the authenticated user email). |
subject | string | yes | Email subject line for the signing invitation. |
message | string | no | Optional custom message body for the invitation email. |
payload | object | no | Additional official invite fields. |
signnow.signnow_send_freeform_invite 2 parameters
kosmo integrations:schema signnow.signnow_send_freeform_invite --json | Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | yes | Document ID. |
payload | object | yes | Full official invite payload. |
signnow.signnow_cancel_field_invite 1 parameters
kosmo integrations:schema signnow.signnow_cancel_field_invite --json | Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | yes | Document ID. |
signnow.signnow_cancel_freeform_invite 1 parameters
kosmo integrations:schema signnow.signnow_cancel_freeform_invite --json | Parameter | Type | Required | Description |
|---|---|---|---|
invite_id | string | yes | Invite ID. |
signnow.signnow_get_current_user 0 parameters
kosmo integrations:schema signnow.signnow_get_current_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
signnow.signnow_api_get 2 parameters
kosmo integrations:schema signnow.signnow_api_get --json | Parameter | Type | Required | Description |
|---|---|---|---|
path | string | yes | Relative SignNow API path. |
params | object | no | Query parameters. |
signnow.signnow_api_post 2 parameters
kosmo integrations:schema signnow.signnow_api_post --json | Parameter | Type | Required | Description |
|---|---|---|---|
path | string | yes | Relative SignNow API path. |
payload | object | no | JSON body. |
signnow.signnow_api_put 2 parameters
kosmo integrations:schema signnow.signnow_api_put --json | Parameter | Type | Required | Description |
|---|---|---|---|
path | string | yes | Relative SignNow API path. |
payload | object | no | JSON body. |
signnow.signnow_api_delete 2 parameters
kosmo integrations:schema signnow.signnow_api_delete --json | Parameter | Type | Required | Description |
|---|---|---|---|
path | string | yes | Relative SignNow API path. |
payload | object | no | Optional JSON body. |
Permissions
Headless calls still follow the integration read/write permission policy. Configure read/write defaults with
integrations:configure. Add --force only for trusted automation that should bypass that policy.