docweave-dev API

openapi: 3.1.0
info:
  title: docweave-dev API
  version: '2026-10-30'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-30: 6 operation(s) read from 40 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; docweave-dev has published no machine-readable contract that
    the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 3
    documentation: 3
    pages-with-code: 34
    pages-read: 40
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-30'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docweave.dev/best-pdf-generation-api
  - https://docweave.dev/glossary/html-to-pdf-api
  - https://docweave.dev/glossary/pdf-generation-api
  - https://docweave.dev/alternatives/pdfendpoint
  - https://docweave.dev/alternatives/api2pdf
  - https://docweave.dev/alternatives/restpack
  - https://docweave.dev/pdf-api-for-ai-agents
  - https://docweave.dev/alternatives/apitemplate
  - https://docweave.dev/alternatives/pdfgeneratorapi
  - https://docweave.dev/docs
  - https://docweave.dev/generate-pdf
  - https://docweave.dev/alternatives
  - https://docweave.dev/llms.txt
  - https://docweave.dev/generate-pdf-from-n8n
  - https://docweave.dev/generate-pdf-from-make
  - https://docweave.dev/use-cases/invoices
  - https://docweave.dev/use-cases/receipts
  - https://docweave.dev/use-cases/certificates
  - https://docweave.dev/use-cases/reports
  - https://docweave.dev/use-cases/quotes
  - https://docweave.dev/use-cases/contracts
  - https://docweave.dev/use-cases/tickets
  - https://docweave.dev/use-cases/resumes
  - https://docweave.dev/use-cases/statements
  - https://docweave.dev/use-cases/labels
  - https://docweave.dev/use-cases/boarding-passes
  - https://docweave.dev/use-cases/purchase-orders
  - https://docweave.dev/generate-pdf-in-node
  - https://docweave.dev/generate-pdf-in-python
  - https://docweave.dev/generate-pdf-in-ruby
  - https://docweave.dev/generate-pdf-in-java
  - https://docweave.dev/generate-pdf-in-nextjs
  - https://docweave.dev/generate-pdf-in-rails
  - https://docweave.dev/generate-invoice-pdf-in-node
  - https://docweave.dev/generate-invoice-pdf-in-python
  - https://docweave.dev/generate-receipt-pdf-in-node
  - https://docweave.dev/generate-receipt-pdf-in-python
  - https://docweave.dev/generate-certificate-pdf-in-node
  - https://docweave.dev/generate-report-pdf-in-node
  - https://docweave.dev/generate-report-pdf-in-python
paths:
  /api/v1/pdf:
    get:
      operationId: get_api_v1_pdf
      tags:
      - Api
      summary: Point Docweave at a URL (or send HTML or a template) and get a PDF back.
      x-source: https://docweave.dev/alternatives/api2pdf
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1PdfResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_pdf
      tags:
      - Api
      summary: POST /api/v1/pdf
      x-source: https://docweave.dev/best-pdf-generation-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1PdfRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://docweave.dev/api/v1/pdf  -H \"Authorization: Bearer dw_live_your_key\"  -H \"Content-Type: application/json\" \
          \ -H \"Accept: application/pdf\"  -d '{\n \"source\": { \"type\": \"html\", \"html\": \"<h1>Invoice #1024</h1>\" },\n \"options\": {\
          \ \"format\": \"A4\", \"margin\": \"20mm\" }\n }'  --output invoice.pdf Prefer to call it from an AI agent instead? Run npx @docweave/mcp\
          \ to add the open-source generate_pdf to"
  /api/v1/pdf/async:
    post:
      operationId: post_api_v1_pdf_async
      tags:
      - Api
      summary: Render a PDF asynchronously, returning a job ID immediately and posting the result to a webhook.
      x-source: https://docweave.dev/docs
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer token for authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1PdfAsyncRequest'
      responses:
        '202':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1PdfAsyncResponse'
      x-evidence:
        kind: documentation
  /api/v1/pdf/batch:
    post:
      operationId: post_api_v1_pdf_batch
      tags:
      - Api
      summary: Render up to 10 PDFs in a single request, returning an array of results.
      x-source: https://docweave.dev/docs
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer token for authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1PdfBatchRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1PdfBatchResponse'
      x-evidence:
        kind: documentation
  /api/v1/pdf/merge:
    post:
      operationId: post_api_v1_pdf_merge
      tags:
      - Api
      summary: POST /api/v1/pdf/merge
      x-source: https://docweave.dev/docs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1PdfMergeRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://docweave.dev/api/v1/pdf/merge  -H \"Authorization: Bearer dw_live_your_key\"  -H \"Content-Type: application/json\"\
          \  -H \"Accept: application/pdf\"  -d '{\n \"sources\": [\n { \"source\": { \"type\": \"html\", \"html\": \"<h1>Cover Page</h1>\" }\
          \ },\n { \"source\": { \"type\": \"markdown\", \"markdown\": \"# Chapter 1\\n\\nContent...\" } },\n { \"source\": { \"type\": \"html\"\
          , \"html\": \"<h1>Appendix</h1>\" } }\n ],\n \"fileName\""
  /api/v1/read:
    post:
      operationId: post_api_v1_read
      tags:
      - Api
      summary: POST /api/v1/read
      x-source: https://docweave.dev/docs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ReadRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://docweave.dev/api/v1/read  -H \"Authorization: Bearer dw_live_your_key\"  -H \"Content-Type: application/json\"\
          \  -d '{\n \"source\": { \"type\": \"url\", \"url\": \"https://example.com/invoice.pdf\" },\n \"options\": { \"format\": \"markdown\"\
          \ }\n }'"
components:
  schemas:
    GetApiV1PdfResponse:
      type: object
      properties:
        PDF document:
          type: string
          description: The generated PDF file
    PostApiV1PdfRequest:
      type: object
      properties:
        source:
          type: object
          properties:
            type:
              type: string
            html:
              type: string
        options:
          type: object
          properties:
            format:
              type: string
            margin:
              type: string
    PostApiV1PdfAsyncRequest:
      type: object
      properties:
        source:
          type: object
          description: Source object with type (html, url, markdown, or template) and corresponding content
        webhookUrl:
          type: string
          description: URL where the render result will be POSTed when complete
        options:
          type: object
          description: Optional rendering options
      required:
      - source
      - webhookUrl
    PostApiV1PdfAsyncResponse:
      type: object
      properties:
        jobId:
          type: string
          description: Unique identifier for the async job
        status:
          type: string
          description: Current status, e.g. processing
    PostApiV1PdfBatchRequest:
      type: object
      properties:
        items:
          type: array
          description: Array of PDF render requests, each with source and optional options
      required:
      - items
    PostApiV1PdfBatchResponse:
      type: object
      properties:
        results:
          type: array
          description: Array of render results
    PostApiV1PdfMergeRequest:
      type: object
      properties:
        sources:
          type: array
          items:
            type: object
            properties:
              source:
                type: object
                properties:
                  type:
                    type: string
                  html:
                    type: string
        fileName:
          type: string
    PostApiV1ReadRequest:
      type: object
      properties:
        source:
          type: object
          properties:
            type:
              type: string
            url:
              type: string
        options:
          type: object
          properties:
            format:
              type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api