APIVerve Documentation Action

Generate PDFs, check spelling, and validate documentation quality

Beta Release - This action is in beta. We'd love your feedback! Open an issue if you encounter any problems.

Browse All APIs | Get Free API Key | Documentation

---

What does this action do?

This action provides access to APIVerve's Documentation APIs directly in your GitHub workflows:

• Convert documentation to PDF
• Spell check documentation files
• Grammar check content
• Measure documentation readability

Available APIs

API	Description
htmltopdf	HTML to PDF is a simple tool for converting HTML to PDF. It returns the PDF file generated from the HTML.
markdowntopdf	Markdown to PDF converts markdown text into professionally formatted PDF documents with Base64-encoded output for easy downloading.
spellchecker	Spell Checker is a simple tool for checking spelling in a given body of text. It returns correction suggestions
grammarcheck	Grammar Check is a simple tool for checking the grammar and spelling of a text. It returns the corrected text.
readabilityscore	Readability Score is a simple tool for calculating the readability score of text. It returns the readability score based on various readability formulas.

---

Quick Start

- name: Documentation
  uses: apiverve/action-documentation@v1
  with:
    api_key: ${{ secrets.APIVERVE_KEY }}
    api: markdowntopdf
    params: '{"markdown": "# Title\n\nYour documentation content here."}'
    output_file: ./docs.pdf

---

Setup

1. Get Your API Key

Sign up for a free account at dashboard.apiverve.com/signup and create an API key.

2. Add Secret to Repository

Go to your repository Settings → Secrets and variables → Actions → New repository secret

• Name: APIVERVE_KEY
• Value: Your API key from the dashboard

3. Use in Workflow

- name: Documentation
  uses: apiverve/action-documentation@v1
  with:
    api_key: ${{ secrets.APIVERVE_KEY }}
    api: markdowntopdf
    params: '{"your": "parameters"}'

---

Inputs

Input	Description	Required	Default
api_key	Your APIVerve API key (or set APIVERVE_API_KEY env var)	Yes*	-
api	API to use: htmltopdf, markdowntopdf, spellchecker, grammarcheck, readabilityscore	No	markdowntopdf
params	JSON parameters for the API	No	{}
output_file	Path to save binary output (images, PDFs)	No	-
format	Response format: json, yaml, or xml	No	json
fail_on_error	Fail workflow if API returns error	No	true

*API key is required but can be provided via input OR APIVERVE_API_KEY / APIVERVE_KEY environment variable.

Outputs

Output	Description
result	Full API response as JSON
data	The data field from response as JSON
status	API status (ok or error)
file	Path to downloaded file (if output_file was used)

---

Examples

Markdown to PDF

Convert markdown documentation to PDF

- name: Markdown to PDF
  id: documentation-0
  uses: apiverve/action-documentation@v1
  with:
    api_key: ${{ secrets.APIVERVE_KEY }}
    api: markdowntopdf
    params: '{"markdown": "# Title\n\nYour documentation content here."}'
    output_file: ./docs.pdf

- name: Upload artifact
  uses: actions/upload-artifact@v4
  with:
    name: markdowntopdf-output
    path: ./docs.pdf

Spell Check

Check spelling in documentation

- name: Spell Check
  id: documentation-1
  uses: apiverve/action-documentation@v1
  with:
    api_key: ${{ secrets.APIVERVE_KEY }}
    api: spellchecker
    params: '{"text": "Your documentation content here"}'

- name: Use result
  run: echo "Result: ${{ steps.documentation-1.outputs.data }}"

---

Full Workflow Example

name: Documentation Workflow

on:
  push:
    branches: [main]
  workflow_dispatch:

jobs:
  documentation:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Run Documentation
        id: result
        uses: apiverve/action-documentation@v1
        with:
          api_key: ${{ secrets.APIVERVE_KEY }}
          api: markdowntopdf
          params: '{"markdown": "# Title\n\nYour documentation content here."}'
          output_file: ./docs.pdf

      - name: Show result
        run: |
          echo "Status: ${{ steps.result.outputs.status }}"
          echo "Data: ${{ steps.result.outputs.data }}"

---

Related Actions

Looking for more APIVerve actions?

• apiverve/action - Generic action for all 350+ APIs
• apiverve/action-release-assets - Generate QR codes, barcodes, and badges for your GitHub releases
• apiverve/action-visual-testing - Capture screenshots and generate PDFs for visual regression testing and documentation
• apiverve/action-dns-monitor - Verify DNS configuration, check propagation, and validate DNSSEC after deployments

Browse all APIVerve Actions →

---

Pricing

• Free tier - Get started with generous free limits
• Pro plans - Higher rate limits and priority support for production use

Check out pricing details.

---

Resources

• API Documentation: docs.apiverve.com
• API Marketplace: apiverve.com/marketplace
• Issues & Support: GitHub Issues
• Email: support@apiverve.com

---

License

MIT - see LICENSE

---

Built by APIVerve - 350+ APIs for developers