Skip to main content
Knowledge APIs will cover the source material Woes uses to ground support answers. This is the API surface for source ingestion, scan health, endpoint evidence, and test readiness.

​
Planned resources

ResourceDescription
SourcesAPI docs, specs, JSON files, Markdown, or websites added to API Context.
Scan statusCurrent ingestion state, failures, and coverage counts.
Endpoint recordsParsed methods, paths, parameters, schemas, examples, and metadata.
Generated MarkdownAI-readable endpoint evidence.
Retrieval chunksSearchable source fragments used for grounded answers.
Credential metadataNon-secret auth status for testing and verification.
Test summariesSafe summaries of test results and coverage.

​
Source categories

OpenAPI

Best for endpoint contracts, schemas, parameters, requests, responses, and auth metadata.

Markdown

Best for guides, examples, troubleshooting, and behavior explanations.

JSON

Best for structured endpoint or schema exports from internal tools.

Website

Best for published documentation that needs to be crawled or imported.

​
Common use cases

  • Add or rescan documentation sources.
  • Check whether ingestion succeeded.
  • Review endpoint coverage from an internal dashboard.
  • Detect stale or partial context.
  • Trigger documentation workflows when scans fail.
  • Compare support questions with missing source coverage.

​
Boundaries

API credentials used for testing should stay separate from source content. Public API responses should not return stored credential values in plaintext. Endpoint-level docs should make it clear which knowledge APIs are read-only, which mutate source state, and which can trigger scans.