API_KEY
docmosis_api_key
Developer setup
No fields declared in this snapshot.
User connection
- Base URLfull · stringRequired
- Access Keygeneric_api_key · stringRequired
DOCMOSIS
Docmosis generates PDF and Word documents from templates, letting developers merge data fields to produce reports, invoices, or letters quickly
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
17
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 1–17 of 17 actions
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.
Untrusted display-only summary
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.
Untrusted display-only summary
DOCMOSIS_ENVIRONMENT_READY
Tool to verify environment readiness. Use when ensuring the environment is active and within quota before rendering documents.
Untrusted display-only summary
DOCMOSIS_ENVIRONMENT_SUMMARY
Tool to retrieve environment summary. Use when you need status, plan, and quota details of your Docmosis environment after authentication.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
DOCMOSIS_GET_RENDER_QUEUE
Tool to get current render queue status and utilization. Use when monitoring queue capacity before scheduling rendering tasks.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
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.
Untrusted display-only summary
DOCMOSIS_LIST_IMAGES
Tool to list available stock images. Use when you need to retrieve image names optionally filtered by folder.
Untrusted display-only summary
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.
Untrusted display-only summary
DOCMOSIS_PING
Tool to check connectivity to Docmosis Cloud services. Use when validating that the service endpoint is reachable before other operations.
Untrusted display-only summary
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.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.