πŸ”—πŸ“₯✨guidesSource: opendocs-core

URL Ingestion Guide

Learn how to ingest documentation from external URLs automatically.

OpenDocs Team1 min read135 words
View original source
Share:π•πŸ’ΌπŸ“˜πŸ”΄πŸŸ§

URL Ingestion Guide #

OpenDocs can automatically fetch and ingest content from external URLs, making it easy to aggregate documentation from multiple sources.

API Endpoint #

http 
POST /api/v1/ingest
Content-Type: application/json

Request Body:

json 
{
  "url": "https://example.com/docs/page",
  "category": "guides",
  "tags": ["external", "imported"],
  "autopublish": false
}

MCP Ingest Tool #

json 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "ingesturl",
    "arguments": {
      "url": "https://example.com/docs/page"
    }
  }
}

What Gets Captured #

  • Title - Extracted from page title or first h1
  • Content - Main content converted to Markdown
  • Source URL - Original URL preserved
  • Source Identifier - Domain automatically captured
  • Metadata - Open Graph data, publish date, author

Supported Formats #

  • HTML pages (auto-converted to Markdown)
  • Markdown files
  • Plain text
  • JSON (structured content)
Source Attribution
OpenDocs keeps source fields explicit. Unknown values are labeled instead of invented.

Canonical source

https://docs.opendocs.dev/guides/ingestion

Original source

https://docs.opendocs.dev/guides/ingestion

Source domain

opendocs-core

Author

OpenDocs Team

Publisher

opendocs-core

License / usage

Unknown. Review the original source terms before republishing beyond public-safe excerpts.

Score
Version docs-phase3-2026-05-20
88

Overall quality score, confidence 82%

Source credibility95
Freshness92
Completeness68
Extraction quality85
Attribution confidence95
Readability
difficult | grade 37.7 | format 78

1 sentences, 5 headings, 9 list items.

Shorten long sentences for public documentation readability.

Keep source attribution visible in the rendered document.

Search Appearance
canonical document page
OpenDocs keeps inspected URLs, canonical URLs, snippets, and rich-result signals explicit; Search Console metrics are not treated as visits.
Social Card
URL Ingestion Guide
Learn how to ingest documentation from external URLs automatically.
Duplicate State
No duplicate is asserted on this page without a matching canonical URL or content hash cluster.
Trace
docs-score-f5d6f1d231cbbc01a5a4f3c9
Export
Use public export endpoints for Markdown/JSON. Protected publishing still requires PLATPHORM_API_KEY.
ingestionurlimportautomation

Related Documentation

πŸ’»πŸ–₯οΈπŸ”’πŸš€πŸ§ͺ

The difficulty of making sure your website is broken - Let's Encrypt

Have you ever needed to make sure your website has a broken certificate? While many tools exist to help run an HTTPS server with valid certificates, there aren’t tools to make sure your certificate is revoked or expired. This is not a problem most people have. Tools to help manage certificates are always focused on avoiding those problems, not creating them. Let’s Encrypt is a Certificate Authority, and so we have unusual problems we need to solve.

7 min read

⚑πŸ–₯οΈπŸ”’πŸ—οΈπŸ“°

What is JA4 and JA4+ Fingerprinting?

An overview of JA4 fingerprinting, a passive technique for combatting bots.

4 min read

πŸ“€πŸ“„βœ¨

Media Content

1 min read

πŸ””βš™οΈπŸ“‘

Webhooks Guide

Set up webhooks to get notified when documentation changes.