DocPatch Documentation - Getting Started

What is DocPatch?

DocPatch solves a common engineering problem: migrating documentation between platforms. Whether you're moving from Confluence to GitBook, converting Markdown to HTML, or consolidating docs across formats, DocPatch handles batch transformations automatically.

Instead of manually converting thousands of documents—which takes weeks—DocPatch processes them in hours. It preserves metadata, links, and formatting, making migration friction-free.

Sign Up (Free)

Getting started takes under a minute — no password required:

Step 1: Click "Try Free Tier"

On oculix.io, click "Try Free Tier" or "Get Started" to open the signup form.

Step 2: Enter Your Name and Email

No credit card, no password. Just your name and email.

Step 3: Verify Your Email

We'll send a verification link to your inbox. Click it to activate your account — no password to set.

Step 4: Copy Your API Key

Your key is shown once on the verification page — copy it right away. Use it as the x-api-key header on every request.

Your First Migration

Let's migrate a single document to test the API. You can also just use the live widget above instead of calling the API directly.

Step 1: Prepare Your Document

DocPatch currently accepts Markdown input only, converted for a target documentation framework (Docusaurus, MkDocs, GitBook). Direct source-format conversion (Confluence, Notion, Word, HTML) is planned as a paid-plan feature (Developer tier and above) — not live yet.

Step 2: Make Your First API Call

Send a POST request to the DocPatch API with your markdown. This is the real, live endpoint — same one the widget above calls:

curl -X POST https://docpatch-api-885208777871.us-central1.run.app/v1/docpatch/migrate \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "markdownContent": "# Getting Started\n\nThis is a sample doc...",
    "targetFramework": "docusaurus"
  }'
    

Step 3: Get Your Result

The call is synchronous — no batch ID, no polling, no webhooks. You get your converted document directly in the response:

{
  "status": "success",
  "migratedDocument": "---\ntitle: Getting Started\n---\n\n# Getting Started\n\nThis is a sample doc..."
}
    

Usage Limits

Each call converts one document. Your plan sets how many you can convert per month, not how many fit in a single request:

      Free Tier: 20 conversions/month

      Developer Tier ($39/mo): 500 conversions/month

      Team Tier ($149/mo): 5,000 conversions/month

Common Use Cases

Confluence → GitBook Migration

Export all Confluence pages as HTML. Send to DocPatch with target_format="markdown". GitBook imports Markdown natively—publish instantly.

Markdown Standardization

Your docs are scattered across 3 formats. Use DocPatch to convert everything to a single standard format (e.g., all to Markdown).

Metadata Extraction

Set preserve_metadata: true and DocPatch extracts author, dates, tags, and custom fields. Useful for reindexing or analytics.

Pricing

Plan	Docs/Month	Cost	Best For
Free	20	$0	Testing, small projects
Developer	500	$39/month	Growing teams, monthly migrations
Team	5,000	$149/month	Enterprise, frequent migrations

No overage charges. When you reach your monthly quota, the API returns a 402 status. Your quota resets monthly; upgrade anytime to increase your limit.

Troubleshooting

Q: "Invalid API Key" Error

A: Re-copy the key from your original verification email — it's only shown once and there's no Settings page to view it again yet. Make sure there are no extra spaces. API keys are case-sensitive.

Q: My Request Is Taking a Long Time

A: Each API call converts one document synchronously — there's no batch mode, job ID, or polling yet. If a single call is hanging longer than a minute or two, contact support rather than waiting.

Q: "Unsupported Format" Error

A: DocPatch supports: markdown, html, txt, rtf. If your source is another format (Word, PDF), convert to one of these first.

Q: How Do I Update My API Key?

A: Key rotation isn't self-serve yet — contact support to have your key reissued. Your old key stops working once the new one is issued, so update all apps using it.

Next Steps

Read the full API reference: Full endpoint documentation with all parameters and response codes.
Batch mode & webhooks: on the roadmap — not live yet. Every call today is a single, synchronous conversion.
Usage tracking: call GET /v1/usage on the auth service with your x-api-key header for your remaining quota and a call-count breakdown by endpoint. A full self-serve dashboard is still on the roadmap.
Join our Slack community: Connect with other developers using DocPatch.

Ready to migrate? Start with 20 free docs to test. No credit card. Upgrade when you're ready.

Subscribe: Growth $39/mo → Subscribe: Scale $149/mo →

← Back to Home

📄 DocPatch Getting Started