NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Docmosis connects to a Nagent workspace with an API key. Once it is connected, agents can call 17 Docmosis actions, such as "Get Batch Upload Status", "Get Docmosis Render Queue" and "Get Render Tags". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Docmosis, with input parameters and output schema.
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
Environment API key; required if not provided in Authorization header.
One or more image names to delete; specify multiple entries to delete multiple images.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Environment API key; required if not provided in Authorization header.
One or more template names to delete; specify multiple entries to delete multiple templates.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DOCMOSIS_ENVIRONMENT_READYTool to verify environment readiness. Use when ensuring the environment is active and within quota before rendering documents.
Input parameters
Docmosis environment API key; required if not provided via headers.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DOCMOSIS_ENVIRONMENT_SUMMARYTool to retrieve environment summary. Use when you need status, plan, and quota details of your Docmosis environment after authentication.
Input parameters
Docmosis environment API key; required with each API call
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DOCMOSIS_GET_API_KEYTool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The identifier for the batch upload job
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DOCMOSIS_GET_IMAGETool 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
Environment API key; required if not provided in headers.
Image name(s) to download; provide one or more names. If multiple names provided (up to 100), the response is a zip archive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DOCMOSIS_GET_RENDER_QUEUETool to get current render queue status and utilization. Use when monitoring queue capacity before scheduling rendering tasks.
Input parameters
Docmosis environment API key; required if not provided in headers.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The tags to query. This can be a single tag or a list of tags separated by the ; (semicolon) character.
The year on which to report statistics. Defaults to the current year.
The month on which to report statistics (1=Jan). Defaults to the current month.
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.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DOCMOSIS_GET_SAMPLE_DATATool 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
Format for the sample data response. Use 'json' for JSON format or 'xml' for XML format.
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.
The name of the template to generate sample data for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DOCMOSIS_GET_TEMPLATETool 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
Environment API key; required if not provided in headers.
Template name(s) to download; provide one or more names. If multiple names provided (up to 100), the response is a zip archive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The unique API key identifying the Environment. If not provided, will be extracted from headers.
If set to "y", "yes" or "true" then the json result will be stringified, otherwise the json response object will be sent in full
The name of the template to retrieve details for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
If true, returns the JSON result as a string; otherwise returns a JSON object.
Docmosis environment API key; if not provided in headers, supply here.
Name of the uploaded template to inspect.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DOCMOSIS_LIST_IMAGESTool to list available stock images. Use when you need to retrieve image names optionally filtered by folder.
Input parameters
Folder path to filter images; returned names are relative to this folder.
Environment API key; required if not provided in headers.
Whether to include subfolders recursively; defaults to true.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
An optional starting folder (path). If not specified, all templates will be listed.
Whether or not to return results in pages. Default=false. If true, pages of 1000 records are returned.
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.
Environment API key; required if not provided in headers.
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.
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.
Whether the list will include items within sub-folders. Defaults to true. 'y', 'yes' and 'true' are all positive indicators.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DOCMOSIS_PINGTool to check connectivity to Docmosis Cloud services. Use when validating that the service endpoint is reachable before other operations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DOCMOSIS_PING_DOCMOSIS_SERVICETool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 17 Docmosis actions on Nagent, including "Get Batch Upload Status", "Get Docmosis Render Queue" and "Get Render Tags". Get Batch Upload Status: Check the status of a template batch upload job. Each action is listed on this page with its input parameters and its output.
Docmosis connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get Batch Upload Status takes 1 required input: userJobId. It returns data, error and successful.