# Docmosis

Docmosis generates PDF and Word documents from templates, letting developers merge data fields to produce reports, invoices, or letters quickly

- **Category:** documents
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 17
- **Triggers:** 0
- **Slug:** `DOCMOSIS`
- **Version:** 20260227_00

## Tools

### Docmosis: Delete Image(s)

**Slug:** `DOCMOSIS_DELETE_IMAGE`

Tool to delete one or more stored images. Use when you need to remove images; ensure imageName(s) are valid before use.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accessKey` | string | No | Environment API key; required if not provided in Authorization header. |
| `imageName` | array | Yes | One or more image names to delete; specify multiple entries to delete multiple images. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Docmosis: Delete Template(s)

**Slug:** `DOCMOSIS_DELETE_TEMPLATE`

Tool to delete one or more templates from the environment. Use when you need to remove templates; multiple templates can be deleted in a single request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accessKey` | string | No | Environment API key; required if not provided in Authorization header. |
| `templateName` | array | Yes | One or more template names to delete; specify multiple entries to delete multiple templates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Docmosis Environment Ready

**Slug:** `DOCMOSIS_ENVIRONMENT_READY`

Tool to verify environment readiness. Use when ensuring the environment is active and within quota before rendering documents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accessKey` | string | Yes | Docmosis environment API key; required if not provided via headers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Docmosis Environment Summary

**Slug:** `DOCMOSIS_ENVIRONMENT_SUMMARY`

Tool to retrieve environment summary. Use when you need status, plan, and quota details of your Docmosis environment after authentication.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accessKey` | string | Yes | Docmosis environment API key; required with each API call |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Docmosis: Get API Key

**Slug:** `DOCMOSIS_GET_API_KEY`

Tool to extract the Docmosis API access key from connection metadata. Use before other Docmosis API calls to retrieve the Bearer token from the Authorization header.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Batch Upload Status

**Slug:** `DOCMOSIS_GET_BATCH_UPLOAD_STATUS`

Tool to check the status of a template batch upload job. Use when monitoring batch upload progress or checking if a batch upload has completed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `userJobId` | string | Yes | The identifier for the batch upload job |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Docmosis Images

**Slug:** `DOCMOSIS_GET_IMAGE`

Tool to download one or more images. Use when you need to retrieve stored image files by name. If multiple names provided, images are returned in a zip archive.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accessKey` | string | No | Environment API key; required if not provided in headers. |
| `imageName` | array | Yes | Image name(s) to download; provide one or more names. If multiple names provided (up to 100), the response is a zip archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Docmosis Render Queue

**Slug:** `DOCMOSIS_GET_RENDER_QUEUE`

Tool to get current render queue status and utilization. Use when monitoring queue capacity before scheduling rendering tasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accessKey` | string | No | Docmosis environment API key; required if not provided in headers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Render Tags

**Slug:** `DOCMOSIS_GET_RENDER_TAGS`

Tool to retrieve statistics on renders tagged with user-defined phrases. Returns page counts and document counts aggregated monthly. Use when reporting activity of user groups or features.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | string | Yes | The tags to query. This can be a single tag or a list of tags separated by the ; (semicolon) character. |
| `year` | integer | No | The year on which to report statistics. Defaults to the current year. |
| `month` | integer | No | The month on which to report statistics (1=Jan). Defaults to the current month. |
| `nMonths` | integer | No | The number of months on which to report statistics. Defaults to 1. If more than one month is being reported, the months prior to the specified year and month are included. In other words, this call always reports up to the specified month. |
| `padBlanks` | string | No | If true (or 'y'), zero values will be included where no data exists. This may make parsing the returned result easier since it will always contain values for the tags requested over the given time period by padding the data with zero-values as required. Defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template Sample Data

**Slug:** `DOCMOSIS_GET_SAMPLE_DATA`

Tool to generate sample data for a Docmosis template based on its structure. Creates placeholder values that can be used for testing renders. Returns data in JSON or XML format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("json" | "xml") | No | Format for the sample data response. Use 'json' for JSON format or 'xml' for XML format. |
| `stringify` | string | No | If set to "y", "yes", or "true", the JSON result will be stringified as a string. Otherwise, the JSON response object will be sent in full. |
| `template_name` | string | Yes | The name of the template to generate sample data for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Docmosis Templates

**Slug:** `DOCMOSIS_GET_TEMPLATE`

Tool to retrieve originally uploaded templates. Use when you need to download template files by name. If multiple names provided (up to 100), templates are returned in a zip archive.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accessKey` | string | No | Environment API key; required if not provided in headers. |
| `templateName` | array | Yes | Template name(s) to download; provide one or more names. If multiple names provided (up to 100), the response is a zip archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Docmosis Template Details

**Slug:** `DOCMOSIS_GET_TEMPLATE_DETAILS`

Tool to retrieve metadata for an uploaded template. Returns name, size, MD5 hash, last modified date, and error status. Use after uploading a template to verify it was stored correctly or to check if it has errors.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accessKey` | string | No | The unique API key identifying the Environment. If not provided, will be extracted from headers. |
| `stringify` | string | No | If set to "y", "yes" or "true" then the json result will be stringified, otherwise the json response object will be sent in full |
| `templateName` | string | Yes | The name of the template to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Docmosis Template Structure

**Slug:** `DOCMOSIS_GET_TEMPLATE_STRUCTURE`

Tool to retrieve a template's parsed structure: fields, repeats, conditions, images, and refs. Use after uploading a template to inspect its JSON structure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stringify` | boolean | No | If true, returns the JSON result as a string; otherwise returns a JSON object. |
| `access_key` | string | No | Docmosis environment API key; if not provided in headers, supply here. |
| `template_name` | string | Yes | Name of the uploaded template to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Docmosis: List Images

**Slug:** `DOCMOSIS_LIST_IMAGES`

Tool to list available stock images. Use when you need to retrieve image names optionally filtered by folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder` | string | No | Folder path to filter images; returned names are relative to this folder. |
| `accessKey` | string | No | Environment API key; required if not provided in headers. |
| `includeSubFolders` | boolean | No | Whether to include subfolders recursively; defaults to true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Docmosis: List Templates

**Slug:** `DOCMOSIS_LIST_TEMPLATES`

Tool to list all templates available in the environment. Use when you need to retrieve template names, optionally filtered by folder with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `folder` | string | No | An optional starting folder (path). If not specified, all templates will be listed. |
| `paging` | string | No | Whether or not to return results in pages. Default=false. If true, pages of 1000 records are returned. |
| `pageSize` | string | No | The size of pages when paging is active. Default is 1000 (which is also the maximum supported). Since the list returns folder names as items, the folders themselves count in the page size. |
| `accessKey` | string | No | Environment API key; required if not provided in headers. |
| `pageToken` | string | No | When paging is true, this token identifies the next page to retrieve. The page token is null for the first page. When the first page response returns, it contains the token required to request the next page. |
| `includeDetail` | string | No | Include extra detail about templates (if true extra details such as whether the template has errors is obtained but listing is much slower). Default=false. |
| `includeSubFolders` | string | No | Whether the list will include items within sub-folders. Defaults to true. 'y', 'yes' and 'true' are all positive indicators. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Docmosis Ping

**Slug:** `DOCMOSIS_PING`

Tool to check connectivity to Docmosis Cloud services. Use when validating that the service endpoint is reachable before other operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Ping Docmosis Service

**Slug:** `DOCMOSIS_PING_DOCMOSIS_SERVICE`

Tool to check that Docmosis Cloud services are online and at least one server is listening. Use for diagnostics and monitoring to verify service availability.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |