New to Corsair? See API access, authentication, and error handling.
Admin
environmentReady
admin.environmentReady
Check whether the environment is active and ready to render
Risk: read
environmentSummary
admin.environmentSummary
Get environment status, plan details, and quota usage
Risk: read
accountEnvironmentSummary full type
accountEnvironmentSummary full type
getBatchUploadStatus
admin.getBatchUploadStatus
Check status for a template batch upload job
Risk: read
Output
jobStatus full type
jobStatus full type
getRenderQueue
admin.getRenderQueue
Get current render queue utilization and delay
Risk: read
queue full type
queue full type
getRenderTags
admin.getRenderTags
Get monthly render statistics grouped by custom tags
Risk: read
Output
ping
admin.ping
Check basic connectivity to the Docmosis API
Risk: read
pingService
admin.pingService
Verify that Docmosis service listeners are online
Risk: read
Auth
getApiKey
auth.getApiKey
Confirm a Docmosis access key is configured and return a masked preview of it
Risk: read
Images
delete
images.delete
Delete one or more stored images
Risk: destructive · Irreversible
Output
get
images.get
Download one or more uploaded images
Risk: read
Output
list
images.list
List available stored images, optionally by folder
Risk: read
Output
imageList full type
imageList full type
Templates
delete
templates.delete
Delete one or more templates from the environment
Risk: destructive · Irreversible
Output
get
templates.get
Download one or more template files
Risk: read
Output
getDetails
templates.getDetails
Get metadata details for a specific template
Risk: read
Output
templateDetails full type
templateDetails full type
getSampleData
templates.getSampleData
Generate sample JSON or XML data from a template structure
Risk: read
Output
templateDetails full type
templateDetails full type
getStructure
templates.getStructure
Get parsed field and structure metadata for a template
Risk: read
Output
templateStructure full type
templateStructure full type
list
templates.list
List templates with optional folder and paging filters
Risk: read
Output
templateList full type
templateList full type
render
templates.render
Generate a document from a template and JSON/XML data
Risk: write
Output