Skip to main content

OpenDocs FAQ

Public-safe by defaultPLATPHORM_API_KEY for protected actions

Answers for public clipping, ingestion previews, source attribution, local drafts, MCP/API access, and protected documentation workflows.

What is OpenDocs for?
OpenDocs is the public documentation and knowledge-capture layer for PlatPhormNews. It helps humans and agents clip, clean, tag, attribute, submit, search, and publish documentation across the network.
What can I do without an API key?
Public-safe browsing, search, category and tag navigation, public submissions, public clipping previews, public feed and sitemap consumption, OpenAPI access, llms files, health summaries, and read-only MCP introspection are open by default.
When is PLATPHORM_API_KEY required?
Protected document persistence, private ingestion, review, publishing, webhook mutation, bulk imports, reporting, sync jobs, sensitive audit details, and future protected MCP tools require PLATPHORM_API_KEY.
How does clipping handle source attribution?
Every clip keeps the original source URL, canonical URL when discoverable, source domain or platform, public author and publication date when available, ingestion date, and an attribution block.
Does Reddit clipping require Reddit auth?
No. Phase 2 only uses public Reddit URLs that are accessible without authentication. If a post is unavailable, removed, private, rate-limited, or blocked, OpenDocs returns an honest degraded preview instead of invented comments.
Can OpenDocs read private Google Drive or Dropbox links?
No. Phase 2 supports public links only and does not bypass permissions or store OAuth tokens. Login-required or permission-denied links are reported as unavailable or degraded.
How are tags suggested?
Tags are suggested deterministically from source domain, source platform, title, headings, content keywords, URL patterns, and the existing taxonomy. Model-assisted tagging is server-only and degraded unless a model provider is configured.
Where are local drafts stored?
Non-sensitive draft content and clipped previews can be stored in browser-local draft state when server persistence is unavailable. API keys, author email, private submissions, private source data, and protected notes are not stored in local drafts.
Clip Content
Preview public URLs or pasted text before submitting anything for review.
API Reference
See public and protected REST endpoints with PLATPHORM_API_KEY policy.
Agent Access
Use MCP read-only introspection and public-safe Docs tools where bounded.