Skip to content
Changelog

Report a bug

Docmosis integration: operations for AI agents

Docmosis connects to Type.com as an integration. This page lists the 21 operations documented for Claude and Codex in Type.com: 10 read, 9 write, 2 destructive.

About Docmosis

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

Categories: Documents & Forms

How to connect Docmosis to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

21 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

21 operations listed.

Admin

  • Read

    Ping

    The ping service provides a direct check that the services are online and reachable. This is useful for diagnostics and for monitoring purposes. The response is empty, and the HTTP response code “200” is the success indicator.

    GET /ping

  • Write

    Environment Ready

    The Environment ready service provides the ability to check whether an environment is ready to service document requests. This service is suitable for linking to automated monitoring systems for important Docmosis Environments.

    POST /environment/ready

  • Write

    Environment Summary

    The environment summary service returns details about an environment including plan information, status and quotas. It is for information purposes and not intended for monitoring.

    POST /environment/summary

Convert

  • Write

    Convert

    The convert service allows files to be converted between formats. The process is a simple conversion with no concept of templates and data. It applies to spreadsheet, presentation and drawing types of document.

    POST /convert

Images

  • Read

    Get Image

    Get image retrieves the image that was originally uploaded. Multiple imageName parameters can be specified to download in a zip file (up to 100).

    POST /getImage

  • Read

    List Images

    List images lists the images available.

    POST /listImages

  • Write

    Upload Image

    The Image Upload service works the same as the template upload service, but is significantly simpler since there are few options to set.

    POST /uploadImage

  • Destructive

    Delete Image

    The delete image service deletes the specified image. Multiple imageName parameters can be specified to delete multiple images.

    POST /deleteImage

Render

  • Read

    Get Render Queue

    The render queue service returns info about the current status of the render queue for the specified Environment.

    POST /getRenderQueue

  • Read

    Get Render Tags

    The get render tags service allows statistics to be retrieved on renders that were tagged with user-defined phrases (“tags”). The statistics include page counts and document counts that have been collected against the tags, aggregated monthly.

    POST /getRenderTags

  • Write

    Render

    The /render service is the document production ‘work-horse’, and it is expected to be the main service that all applications will use. See notes above for more details on key parameters.

    POST /render

Templates

  • Read

    Get Template Details

    Get Template Details retrieves the details of a template that was originally uploaded, but not the template itself.

    POST /getTemplateDetails

  • Read

    Get Template

    Get Template retrieves the template that was originally uploaded. Multiple templateName parameters can be specified to download multiple templates in one zip response (up to 100 in one request).

    POST /getTemplate

  • Read

    Get Template Sample Data

    The get sample data service allows sample data to be generated for a template based on the current structures in the template. The sample data can be created in JSON or XML format which can then be fed back to the render service to generate populated documents.

    POST /getSampleData

  • Read

    Get Template Structure

    Get Template Structure retrieves the structure of a template that has been uploaded. The structure returned describes fields, repeating and conditional sections etc.

    POST /getTemplateStructure

  • Read

    List Templates

    List templates lists the templates available.

    POST /listTemplates

  • Write

    Upload Template

    Upload a template to be (later) rendered into documents. When a template is uploaded, Docmosis analyses it and will report any errors in the template at this time. Docmosis has a special capability to report errors in the template within rendered documents.

    POST /uploadTemplate

  • Write

    Upload Template Batch Cancel

    This service allows a currently running template upload batch job to be cancelled. This service will return failure only if there was an error cancelling the job.

    POST /uploadTemplateBatchCancel

  • Write

    Upload Template Batch

    Upload multiple templates contained in a Zip file. The zip file may be a simple list of templates or may have templates organized into folders. The folder structure of the zip file will be replicated in the cloud Environment.

    POST /uploadTemplateBatch

  • Write

    Upload Template Batch Status

    This service reports on a currently or previously running template batch upload job. In the response, the “jobStatus” payload contains multiple items to establish the status of the job.

    POST /uploadTemplateBatchStatus

  • Destructive

    Delete Template

    The delete template service deletes the specified template. Multiple templateName parameters can be specified to delete multiple templates.

    POST /deleteTemplate

See How connections work for access and permissions, or browse all integrations.