docuqueue-com Templates API
The Templates API from docuqueue-com — 8 operation(s) for templates.
The Templates API from docuqueue-com — 8 operation(s) for templates.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/docuqueue-com:docuqueue-com-templates-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: DocuQueue Templates API
description: Convert web pages and raw HTML into beautifully formatted PDF files. Sign up at docuqueue.com to get your API key.
version: 1.0.0
tags:
- name: Templates
paths:
/api/v1/templates:
post:
tags:
- Templates
summary: Create a template
description: Create a new Jinja2 HTML template. Schema is auto-extracted from the HTML.
operationId: create_template_api_v1_templates_post
parameters:
- name: Authorization
in: header
required: false
schema:
type: string
title: Authorization
- name: api-key
in: header
required: false
schema:
type: string
title: Api-Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateCreateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Templates
summary: List templates
description: List your templates plus all system (pre-built) templates.
operationId: list_templates_api_v1_templates_get
parameters:
- name: Authorization
in: header
required: false
schema:
type: string
title: Authorization
- name: api-key
in: header
required: false
schema:
type: string
title: Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TemplateResponse'
title: Response List Templates Api V1 Templates Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/templates/docx:
post:
tags:
- Templates
summary: Upload a .docx template
description: Upload a .docx file as a template. Schema is auto-extracted from {{ placeholders }} and {% for %} loops.
operationId: create_docx_template_api_v1_templates_docx_post
parameters:
- name: Authorization
in: header
required: false
schema:
type: string
title: Authorization
- name: api-key
in: header
required: false
schema:
type: string
title: Api-Key
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_create_docx_template_api_v1_templates_docx_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/templates/{template_id}:
get:
tags:
- Templates
summary: Get template
description: Retrieve a single template with its full schema.
operationId: get_template_api_v1_templates__template_id__get
parameters:
- name: template_id
in: path
required: true
schema:
type: string
title: Template Id
- name: Authorization
in: header
required: false
schema:
type: string
title: Authorization
- name: api-key
in: header
required: false
schema:
type: string
title: Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Templates
summary: Update template
description: Update a template's name, description, or HTML content. Schema is re-extracted automatically.
operationId: update_template_api_v1_templates__template_id__put
parameters:
- name: template_id
in: path
required: true
schema:
type: string
title: Template Id
- name: Authorization
in: header
required: false
schema:
type: string
title: Authorization
- name: api-key
in: header
required: false
schema:
type: string
title: Api-Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateUpdateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Templates
summary: Delete template
description: Delete a user-owned template. System templates cannot be deleted.
operationId: delete_template_api_v1_templates__template_id__delete
parameters:
- name: template_id
in: path
required: true
schema:
type: string
title: Template Id
- name: Authorization
in: header
required: false
schema:
type: string
title: Authorization
- name: api-key
in: header
required: false
schema:
type: string
title: Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/templates/{template_id}/fill:
post:
tags:
- Templates
summary: Fill template → PDF
description: Fill a template with JSON data and render it as a PDF asynchronously. Returns a job_id — use /api/v1/status/{job_id} to poll and /api/v1/download/{job_id} to fetch the PDF. Costs 1 credit.
operationId: fill_template_api_v1_templates__template_id__fill_post
parameters:
- name: template_id
in: path
required: true
schema:
type: string
title: Template Id
- name: Authorization
in: header
required: false
schema:
type: string
title: Authorization
- name: api-key
in: header
required: false
schema:
type: string
title: Api-Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateFillRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateFillResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/templates/{template_id}/fill-batch:
post:
tags:
- Templates
summary: Batch fill template → multiple PDFs
description: Submit multiple data records to generate multiple PDFs from the same template. Each record creates one job. Costs 1 credit per record (max 50 per request).
operationId: fill_template_batch_api_v1_templates__template_id__fill_batch_post
parameters:
- name: template_id
in: path
required: true
schema:
type: string
title: Template Id
- name: Authorization
in: header
required: false
schema:
type: string
title: Authorization
- name: api-key
in: header
required: false
schema:
type: string
title: Api-Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateFillBatchRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateFillBatchResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/templates/{template_id}/preview:
post:
tags:
- Templates
summary: Preview template (HTML or PDF, no credit cost)
description: 'Render the template with your data. Returns HTML by default. Set header ''Accept: application/pdf'' to get a PDF with correct page size. No credit is consumed.'
operationId: preview_template_api_v1_templates__template_id__preview_post
parameters:
- name: template_id
in: path
required: true
schema:
type: string
title: Template Id
- name: Accept
in: header
required: false
schema:
type: string
default: text/html
title: Accept
- name: Authorization
in: header
required: false
schema:
type: string
title: Authorization
- name: api-key
in: header
required: false
schema:
type: string
title: Api-Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateFillRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/templates/{template_id}/preview-docx:
get:
tags:
- Templates
summary: Preview .docx as PDF (raw template with placeholders)
description: Converts .docx to PDF via LibreOffice and returns the PDF for iframe display.
operationId: preview_docx_as_pdf_api_v1_templates__template_id__preview_docx_get
parameters:
- name: template_id
in: path
required: true
schema:
type: string
title: Template Id
- name: Authorization
in: header
required: false
schema:
type: string
title: Authorization
- name: api-key
in: header
required: false
schema:
type: string
title: Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/templates/{template_id}/preview-sample:
get:
tags:
- Templates
summary: Preview template with sample data (pre-generated PDF)
description: Returns a pre-generated PDF filled with realistic sample data. No credit cost.
operationId: preview_template_sample_api_v1_templates__template_id__preview_sample_get
parameters:
- name: template_id
in: path
required: true
schema:
type: string
title: Template Id
- name: Authorization
in: header
required: false
schema:
type: string
title: Authorization
- name: api-key
in: header
required: false
schema:
type: string
title: Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
TemplateFillResponse:
properties:
job_id:
type: string
title: Job Id
message:
type: string
title: Message
status:
type: string
title: Status
credits_used:
type: integer
title: Credits Used
credits_remaining:
type: integer
title: Credits Remaining
share_url:
anyOf:
- type: string
- type: 'null'
title: Share Url
description: Public share URL (only when share=true)
type: object
required:
- job_id
- message
- status
- credits_used
- credits_remaining
title: TemplateFillResponse
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
TemplateUpdateRequest:
properties:
name:
anyOf:
- type: string
maxLength: 255
minLength: 1
- type: 'null'
title: Name
description:
anyOf:
- type: string
maxLength: 1000
- type: 'null'
title: Description
html_content:
anyOf:
- type: string
maxLength: 2000000
minLength: 10
- type: 'null'
title: Html Content
type: object
title: TemplateUpdateRequest
TemplateCreateRequest:
properties:
name:
type: string
maxLength: 255
minLength: 1
title: Name
description: Human-readable template name
description:
anyOf:
- type: string
maxLength: 1000
- type: 'null'
title: Description
description: Optional description
html_content:
type: string
maxLength: 2000000
minLength: 10
title: Html Content
description: Jinja2 HTML template content
type: object
required:
- name
- html_content
title: TemplateCreateRequest
TemplateFillRequest:
properties:
data:
additionalProperties: true
type: object
title: Data
description: JSON data to fill template variables
options:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Options
description: Optional PDF rendering options
share:
type: boolean
title: Share
description: If true, create a shared document with a public URL
default: false
type: object
required:
- data
title: TemplateFillRequest
TemplateFillBatchResponse:
properties:
job_ids:
items:
type: string
type: array
title: Job Ids
message:
type: string
title: Message
credits_used:
type: integer
title: Credits Used
credits_remaining:
type: integer
title: Credits Remaining
type: object
required:
- job_ids
- message
- credits_used
- credits_remaining
title: TemplateFillBatchResponse
TemplateFillBatchRequest:
properties:
records:
items:
additionalProperties: true
type: object
type: array
maxItems: 50
minItems: 1
title: Records
description: List of data objects to fill (1-50). Each generates one PDF job.
options:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Options
description: Optional PDF rendering options
type: object
required:
- records
title: TemplateFillBatchRequest
TemplateResponse:
properties:
id:
type: string
title: Id
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
schema:
additionalProperties: true
type: object
title: Schema
is_system:
type: boolean
title: Is System
page_size:
type: string
title: Page Size
default: A4
orientation:
type: string
title: Orientation
default: portrait
category:
anyOf:
- type: string
- type: 'null'
title: Category
thumbnail_url:
anyOf:
- type: string
- type: 'null'
title: Thumbnail Url
template_format:
type: string
title: Template Format
default: html
preview_pdf_key:
anyOf:
- type: string
- type: 'null'
title: Preview Pdf Key
created_at:
type: string
title: Created At
updated_at:
type: string
title: Updated At
type: object
required:
- id
- name
- description
- schema
- is_system
- category
- thumbnail_url
- created_at
- updated_at
title: TemplateResponse
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
Body_create_docx_template_api_v1_templates_docx_post:
properties:
file:
type: string
format: binary
title: File
description: .docx template file
name:
type: string
maxLength: 255
minLength: 1
title: Name
description: Human-readable template name
description:
anyOf:
- type: string
maxLength: 1000
- type: 'null'
title: Description
description: Optional description
type: object
required:
- file
- name
title: Body_create_docx_template_api_v1_templates_docx_post