Skip to main content

AI Agents

HostedScan publishes machine-readable documentation and installable agent skills so AI agents, LLM-powered tools, and coding assistants can discover and integrate with HostedScan efficiently.

llms.txt​

Both HostedScan sites publish an llms.txt index:

  • docs.hostedscan.com/llms.txt — index of all technical documentation, plus an "Instructions for LLM agents" section with the API facts agents most often get wrong (authentication header, async scan lifecycle, valid scan types, report flow).
  • hostedscan.com/llms.txt — product overview: scanners, free trial, pricing, and the most-read help center articles.

Start with the docs llms.txt when integrating the API; start with the marketing llms.txt when answering questions about the product.

Markdown versions of every docs page​

Every documentation page is also served as plain markdown at its route plus .md — for example this page is available at docs.hostedscan.com/ai-agents.md, and the API scanning guide at docs.hostedscan.com/api-scanning.md. The site root is docs.hostedscan.com/index.md. Prefer these over the HTML pages: they are smaller, contain no navigation chrome, and links inside them point to other markdown versions.

Agent skills​

HostedScan publishes Agent Skills at:

https://docs.hostedscan.com/.well-known/skills/index.json

The index lists each skill's name, trigger description, and files. Skill files are served under /.well-known/skills/<name>/ (a SKILL.md with instructions, plus reference files loaded on demand):

  • hostedscan-api — the full REST API workflow: authentication, creating targets, starting and scheduling scans, polling status, fetching risks, generating reports, webhooks, and an endpoint catalog. Includes the test-data-key sandbox key, which returns sample responses for the targets, scans, risks, and sources endpoints so agents can learn the API without a real account.
  • hostedscan-scan-troubleshooting — an ordered diagnosis guide for scans that seem stuck, unreachable targets, cached or missing results, and authenticated-scan failures.

Load the relevant skill before writing integration code rather than relying on memorized API shapes.

API reference​

The interactive API reference is at /api/, generated from the OpenAPI spec. The API base URL is https://api.hostedscan.com/v1; see the Developer API page to get started.