Skip to main content
Docmosis logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 17
  • Triggers: 0
  • Slug: DOCMOSIS
  • Version: 20261101_00

Tools

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

Input Parameters

string
Environment API key; required if not provided in Authorization header.
array
required
One or more image names to delete; specify multiple entries to delete multiple images.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_DELETE_TEMPLATETool 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

string
Environment API key; required if not provided in Authorization header.
array
required
One or more template names to delete; specify multiple entries to delete multiple templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_ENVIRONMENT_READYCheck whether a Docmosis environment is ready to service document requests. An environment may be reported ready while over quota if no hard limit is applied.

Input Parameters

string
required
Docmosis environment API key; required if not provided via headers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_ENVIRONMENT_SUMMARYTool to retrieve environment summary. Use when you need status, plan, and quota details of your Docmosis environment after authentication.

Input Parameters

string
required
Docmosis environment API key; required with each API call

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_GET_API_KEYExtract the Docmosis API access key from connection metadata, using the accessKey header or a Bearer token in the Authorization header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_GET_BATCH_UPLOAD_STATUSTool 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

string
required
The identifier for the batch upload job

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_GET_IMAGEDownload one or more stored images by name, up to 100 per request. Successful requests for multiple images return a zip archive; non-200 responses are returned as downloadable error files.

Input Parameters

string
Environment API key; required if not provided in headers.
array
required
Image name(s) to download; provide one or more names. If multiple names provided (up to 100), the response is a zip archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_GET_RENDER_QUEUETool to get current render queue status and utilization. Use when monitoring queue capacity before scheduling rendering tasks.

Input Parameters

string
Docmosis environment API key; required if not provided in headers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_GET_RENDER_TAGSTool 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

string
required
The tags to query. This can be a single tag or a list of tags separated by the ; (semicolon) character.
integer
The year on which to report statistics. Defaults to the current year.
integer
The month on which to report statistics (1=Jan). Defaults to the current month.
integer
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_GET_SAMPLE_DATAGenerate JSON or XML sample data for a Docmosis template based on its structure for testing renders. A template error can result in blank sample data; the response can include template error details.

Input Parameters

string ("json" | "xml")
Format for the sample data response. Use ‘json’ for JSON format or ‘xml’ for XML format.
string
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.
string
required
The name of the template to generate sample data for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_GET_TEMPLATEDownload originally uploaded templates by name, up to 100 per request. Successful requests for multiple templates return a zip archive; non-200 responses are returned as downloadable error files.

Input Parameters

string
Environment API key; required if not provided in headers.
array
required
Template name(s) to download; provide one or more names. If multiple names provided (up to 100), the response is a zip archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_GET_TEMPLATE_DETAILSTool 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

string
The unique API key identifying the Environment. If not provided, will be extracted from headers.
string
If set to “y”, “yes” or “true” then the json result will be stringified, otherwise the json response object will be sent in full
string
required
The name of the template to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_GET_TEMPLATE_STRUCTURETool 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

boolean
If true, returns the JSON result as a string; otherwise returns a JSON object.
string
Docmosis environment API key; if not provided in headers, supply here.
string
required
Name of the uploaded template to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_LIST_IMAGESTool to list available stock images. Use when you need to retrieve image names optionally filtered by folder.

Input Parameters

string
Folder path to filter images; returned names are relative to this folder.
string
Environment API key; required if not provided in headers.
boolean
Whether to include subfolders recursively; defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_LIST_TEMPLATESTool 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

string
An optional starting folder (path). If not specified, all templates will be listed.
string
Whether or not to return results in pages. Default=false. If true, pages of 1000 records are returned.
string
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.
string
Environment API key; required if not provided in headers.
string
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.
string
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.
string
Whether the list will include items within sub-folders. Defaults to true. ‘y’, ‘yes’ and ‘true’ are all positive indicators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_PINGTool to check connectivity to Docmosis Cloud services. Use when validating that the service endpoint is reachable before other operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCMOSIS_PING_DOCMOSIS_SERVICESend a GET request to the Docmosis Cloud ping endpoint to check service availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not