docuqueue-com Conversion API

openapi: 3.2.0
info:
  title: DocuQueue Conversion 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: Conversion
paths:
  /api/v1/convert:
    post:
      tags:
      - Conversion
      summary: Convert URLs to PDF
      description: Submit one or more URLs for asynchronous PDF conversion. Returns a job ID for tracking.
      operationId: convert_urls_api_v1_convert_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/ConvertRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConvertResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/convert-html:
    post:
      tags:
      - Conversion
      summary: Convert raw HTML to PDF
      description: Submit raw HTML content for asynchronous PDF conversion. Returns a job ID for tracking.
      operationId: convert_html_api_v1_convert_html_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/ConvertHtmlRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConvertResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/status/{job_id}:
    get:
      tags:
      - Conversion
      summary: Check job status
      description: Check the current status of a PDF conversion job.
      operationId: get_status_api_v1_status__job_id__get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/download/{job_id}:
    get:
      tags:
      - Conversion
      summary: Download generated PDF
      description: Download the PDF file for a completed conversion job.
      operationId: download_pdf_api_v1_download__job_id__get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ConvertResponse:
      properties:
        job_id:
          type: string
          title: Job Id
          description: Unique identifier for the conversion job
        message:
          type: string
          title: Message
          description: Status message
        status:
          type: string
          title: Status
          description: 'Job status: pending, processing, completed, or failed'
        credits_used:
          type: integer
          title: Credits Used
          description: Credits consumed by this request
        credits_remaining:
          type: integer
          title: Credits Remaining
          description: Credits remaining after this request
      type: object
      required:
      - job_id
      - message
      - status
      - credits_used
      - credits_remaining
      title: ConvertResponse
    StatusResponse:
      properties:
        job_id:
          type: string
          title: Job Id
          description: Unique identifier for the conversion job
        status:
          type: string
          title: Status
          description: 'Job status: queued, processing, completed, or failed'
        pdf_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Pdf Url
          description: Direct PDF URL when status is completed
      type: object
      required:
      - job_id
      - status
      title: StatusResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ConvertRequest:
      properties:
        urls:
          items:
            type: string
            maxLength: 2083
            minLength: 1
            format: uri
          type: array
          maxItems: 10
          minItems: 1
          title: Urls
          description: List of URLs to convert to PDF (1-10 URLs per request)
          example:
          - https://example.com
          - https://example.org
        options:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Options
          description: Optional PDF rendering options (e.g. page format, orientation)
      type: object
      required:
      - urls
      title: ConvertRequest
    ConvertHtmlRequest:
      properties:
        html:
          type: string
          maxLength: 500000
          minLength: 1
          title: Html
          description: Raw HTML content to convert to PDF
          example: <html><body><h1>Hello World</h1></body></html>
        options:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Options
          description: Optional PDF rendering options (e.g. page format, orientation)
      type: object
      required:
      - html
      title: ConvertHtmlRequest
    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