docuqueue-com Forms API
The Forms API from docuqueue-com — 5 operation(s) for forms.
The Forms API from docuqueue-com — 5 operation(s) for forms.
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-forms-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 Forms 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: Forms
paths:
/api/v1/forms/upload:
post:
tags:
- Forms
summary: Upload PDF form template
description: Upload a fillable PDF. Detects form fields, stores the PDF in R2, and creates a template record. Costs 1 credit.
operationId: upload_form_api_v1_forms_upload_post
parameters:
- name: api-key
in: header
required: true
schema:
type: string
description: Your API key
title: Api-Key
description: Your API key
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_upload_form_api_v1_forms_upload_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FormUploadResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/forms/:
get:
tags:
- Forms
summary: List PDF form templates
description: List all PDF form templates owned by the authenticated user.
operationId: list_forms_api_v1_forms__get
parameters:
- name: api-key
in: header
required: true
schema:
type: string
description: Your API key
title: Api-Key
description: Your API key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FormListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/forms/{form_id}:
get:
tags:
- Forms
summary: Get form details
description: Retrieve full details of a PDF form template including field schema and mappings.
operationId: get_form_api_v1_forms__form_id__get
parameters:
- name: form_id
in: path
required: true
schema:
type: string
title: Form Id
- name: api-key
in: header
required: true
schema:
type: string
description: Your API key
title: Api-Key
description: Your API key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FormDetailResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- Forms
summary: Update form field mappings
description: Update alias overrides for a PDF form template's fields.
operationId: update_form_api_v1_forms__form_id__put
parameters:
- name: form_id
in: path
required: true
schema:
type: string
title: Form Id
- name: api-key
in: header
required: true
schema:
type: string
description: Your API key
title: Api-Key
description: Your API key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FormUpdateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FormUpdateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Forms
summary: Delete form template
description: Delete a PDF form template and its stored PDF from R2.
operationId: delete_form_api_v1_forms__form_id__delete
parameters:
- name: form_id
in: path
required: true
schema:
type: string
title: Form Id
- name: api-key
in: header
required: true
schema:
type: string
description: Your API key
title: Api-Key
description: Your API key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FormDeleteResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/forms/{form_id}/fill:
post:
tags:
- Forms
summary: Fill PDF form
description: Fill a PDF form with data and return the filled PDF as a downloadable file. Costs 1 credit.
operationId: fill_form_api_v1_forms__form_id__fill_post
parameters:
- name: form_id
in: path
required: true
schema:
type: string
title: Form Id
- name: api-key
in: header
required: true
schema:
type: string
description: Your API key
title: Api-Key
description: Your API key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FormFillRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/forms/{form_id}/fill-batch:
post:
tags:
- Forms
summary: Batch fill PDF forms
description: Fill multiple PDF forms from the same template. Each record generates one filled PDF. Costs 1 credit per record (max 50).
operationId: fill_form_batch_api_v1_forms__form_id__fill_batch_post
parameters:
- name: form_id
in: path
required: true
schema:
type: string
title: Form Id
- name: api-key
in: header
required: true
schema:
type: string
description: Your API key
title: Api-Key
description: Your API key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FormFillBatchRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FormFillBatchResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
FormUpdateRequest:
properties:
field_mappings:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Field Mappings
description: Mapping of raw PDF field name → user-facing alias. Omitted keys keep their auto-generated alias.
name:
anyOf:
- type: string
maxLength: 255
minLength: 1
- type: 'null'
title: Name
description: Optional new template name
type: object
title: FormUpdateRequest
description: Update field_mappings (alias overrides) for a PDF form template.
FormUploadResponse:
properties:
id:
type: string
title: Id
name:
type: string
title: Name
field_count:
type: integer
title: Field Count
method:
type: string
title: Method
fields:
items:
$ref: '#/components/schemas/FormFieldSchema'
type: array
title: Fields
pdf_key:
type: string
title: Pdf Key
created_at:
type: string
title: Created At
type: object
required:
- id
- name
- field_count
- method
- fields
- pdf_key
- created_at
title: FormUploadResponse
description: Response after uploading a PDF form template.
FormListResponse:
properties:
forms:
items:
$ref: '#/components/schemas/FormListItem'
type: array
title: Forms
total:
type: integer
title: Total
type: object
required:
- forms
- total
title: FormListResponse
description: List of PDF form templates.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
FormListItem:
properties:
id:
type: string
title: Id
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
field_count:
type: integer
title: Field Count
field_mappings:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Field Mappings
created_at:
type: string
title: Created At
updated_at:
type: string
title: Updated At
type: object
required:
- id
- name
- field_count
- created_at
- updated_at
title: FormListItem
description: Summary of a PDF form template for list views.
FormFillBatchRequest:
properties:
records:
items:
additionalProperties: true
type: object
type: array
maxItems: 50
minItems: 1
title: Records
description: List of data objects (1-50). Each record generates one filled PDF.
type: object
required:
- records
title: FormFillBatchRequest
description: Batch-fill multiple PDF forms (one per record).
FormFillBatchResponse:
properties:
forms:
items:
additionalProperties: true
type: object
type: array
title: Forms
total:
type: integer
title: Total
message:
type: string
title: Message
type: object
required:
- forms
- total
- message
title: FormFillBatchResponse
description: Response after batch-filling PDF forms.
FormFillRequest:
properties:
data:
additionalProperties: true
type: object
title: Data
description: JSON data to fill the form fields. Keys may be aliases or raw field names.
type: object
required:
- data
title: FormFillRequest
description: Fill a single PDF form with data.
Body_upload_form_api_v1_forms_upload_post:
properties:
file:
type: string
format: binary
title: File
description: Fillable PDF file
type: object
required:
- file
title: Body_upload_form_api_v1_forms_upload_post
FormDetailResponse:
properties:
id:
type: string
title: Id
name:
type: string
title: Name
description:
anyOf:
- type: string
- type: 'null'
title: Description
template_format:
type: string
title: Template Format
field_count:
type: integer
title: Field Count
method:
type: string
title: Method
fields:
items:
$ref: '#/components/schemas/FormFieldSchema'
type: array
title: Fields
field_mappings:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Field Mappings
pdf_key:
type: string
title: Pdf Key
created_at:
type: string
title: Created At
updated_at:
type: string
title: Updated At
type: object
required:
- id
- name
- template_format
- field_count
- method
- fields
- pdf_key
- created_at
- updated_at
title: FormDetailResponse
description: Full details of a PDF form template including field schema and mappings.
FormFieldSchema:
properties:
name:
type: string
title: Name
type:
type: string
title: Type
page:
type: integer
title: Page
rect:
anyOf:
- items:
type: number
type: array
- type: 'null'
title: Rect
value:
anyOf:
- type: string
- type: 'null'
title: Value
alias:
anyOf:
- type: string
- type: 'null'
title: Alias
type: object
required:
- name
- type
- page
title: FormFieldSchema
description: A single detected form field.
FormUpdateResponse:
properties:
id:
type: string
title: Id
name:
type: string
title: Name
field_mappings:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Field Mappings
updated_at:
type: string
title: Updated At
type: object
required:
- id
- name
- updated_at
title: FormUpdateResponse
description: Response after updating a form template.
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
FormDeleteResponse:
properties:
id:
type: string
title: Id
message:
type: string
title: Message
type: object
required:
- id
- message
title: FormDeleteResponse
description: Response after deleting a form template.