API Endpoints

{
  "service_type": "platform",
  "base_url": "https://readme.com",
  "auth_method": "api_key",
  "auth_config": {
    "notes": "ReadMe is itself an API documentation platform. Its own public REST API (developer.readme.io / docs.readme.com) uses an API key passed via HTTP Basic auth or an Authorization header. Keys are generated within a ReadMe project under Configuration > API Keys. No public API key is issued without an account.",
    "header_scheme": "Authorization: Basic <base64(api_key:)>",
    "docs_reference": "https://docs.readme.com/main/reference"
  },
  "endpoints": [
    {
      "name": "Get project metadata",
      "method": "GET",
      "path": "/v1",
      "description": "Returns metadata about the ReadMe project associated with the API key."
    },
    {
      "name": "List API definitions / endpoints",
      "method": "GET",
      "path": "/v1/api-specification",
      "description": "List OpenAPI/Swagger specs and their endpoints in the project."
    },
    {
      "name": "Create/update API spec",
      "method": "POST",
      "path": "/v1/api-specification",
      "description": "Upload an OpenAPI document to create or update the API reference."
    },
    {
      "name": "List docs categories",
      "method": "GET",
      "path": "/v1/categories",
      "description": "List documentation categories (guides section structure)."
    },
    {
      "name": "Create/update doc",
      "method": "POST",
      "path": "/v1/docs",
      "description": "Create or update a documentation page (Markdown body supported)."
    },
    {
      "name": "List changelogs",
      "method": "GET",
      "path": "/v1/changelogs",
      "description": "List changelog entries."
    },
    {
      "name": "List custom pages",
      "method": "GET",
      "path": "/v1/custompages",
      "description": "List custom (recipe) pages."
    },
    {
      "name": "List versions",
      "method": "GET",
      "path": "/v1/version",
      "description": "List documentation versions."
    }
  ],
  "pricing_model": {
    "type": "freemium",
    "details": {
      "free_tier": "Free plan available for small projects (limited to a single project and a capped number of versions). Historically there is also a free 'Hobby'/startup tier.",
      "paid_tiers": "Team and Enterprise plans sold per-project/month, with a separate pricing model for larger orgs (Enterprise, custom quote).",
      "startup_program": "ReadMe for Startups offers discounted pricing/perks for early-stage companies (https://readme.com/startup).",
      "notes": "Pricing page: https://readme.com/pricing. Exact numbers are not exposed in the provided content; confirm current rates at that URL."
    }
  },
  "rate_limits": {
    "documented": false,
    "notes": "ReadMe's public REST API is rate-limited; documented in the reference (docs.readme.com). Typical limits are on the order of hundreds of requests per hour per API key, returning HTTP 429 when exceeded. Verify current thresholds in the API reference."
  },
  "capabilities": [
    "Hosted, interactive API reference documentation generated from OpenAPI/Swagger specs",
    "Personalized developer hub / documentation site hosting",
    "Markdown and MDX-ish authoring with rich embeds and recipes",
    "Two-way Git sync (GitHub, GitLab, Bitbucket) with Git-backed version history",
    "Branching and reviews workflow for docs changes (shareable branches, PR-like reviews)",
    "AI Writer that watches the codebase and proposes doc updates as branches",
    "Ask AI (AI-powered search answering user questions from docs) and AI Linter (style-guide enforcement)",
    "Docs Audit to surface documentation gaps and standards violations",
    "MCP server generation to expose APIs directly to AI agents, with MCP metrics/observability",
    "AI-ready documentation/Markdown endpoints (Accept: text/markdown, .md URL suffix)",
    "Custom domains, custom theming, and CSS/JS control",
    "Developer-facing API metrics and logs (who read the docs, what they ran)",
    "CLI tool for authoring and syncing docs from the terminal",
    "Enterprise-grade security, SSO, audit logs, and compliance"
  ],
  "raw_analysis": "ReadMe (readme.com) is a developer documentation platform, not primarily a data/API vendor. It is the leading 'docs hub' product: teams point it at an OpenAPI/Swagger spec and it generates an interactive API reference plus a fully hostable docs site with changelog, guides, and search. The company has been around since roughly 2015 and is well established in the developer-tools category, with an Enterprise offering covering SSO, audit logs, and security review. Its buyers are API product teams, developer-relations teams, and technical writers.\n\nFrom a 'platform that may not have a public REST API' standpoint, ReadMe actually DOES expose a public REST API (docs.readme.com/main/reference), authenticated with a project-scoped API key (HTTP Basic/Authorization header). The endpoints above are representative resourc

3/3 tests passed

```json
{
  "overall": 82,
  "dimensions": {
    "token_efficiency": 8.5,
    "first_try_success": 8.0,
    "response_parseability": 9.5,
    "error_clarity": 7.5,
    "doc_quality": 9.0,
    "auth_simplicity": 7.5,
    "latency": 9.5,
    "consistency": 8.5
  },
  "pricing_normalized": {
    "model": "freemium",
    "free_tier": "Single project, capped versions",
    "paid_tiers": "Team & Enterprise per-project/month; Enterprise custom quote",
    "notes": "Exact prices not exposed in provided content; verify at readme.com/pricing"
  },
  "issues": [
    "Exact pricing numbers are not surfaced in the provided content, making cost comparison ambiguous for agents advising users.",
    "Auth/onboarding details (SSO, magic link, signup flow) are not documented in the supplied material; assumed mid-tier.",
    "Free tier limits (1 project, capped versions) may be restrictive for multi-API teams.",
    "Error-clarity signals (explicit documented limitations and failure modes) are not evidenced in the provided content."
  ],
  "recommendations": [
    "Surface a machine-readable pricing endpoint (e.g., /pricing.md or JSON) so agents can answer cost questions without hallucinating.",
    "Publish onboarding steps and auth options in llms.txt / docs index for agent-driven signup flows.",
    "Expose a public status/uptime page URL in llms.txt to strengthen consistency signals.",
    "Document explicit free-tier limits and upgrade triggers to improve error_clarity.",
    "Provide example MCP server + API request/response examples in Markdown endpoints to boost first_try_success for agent integration."
  ]
}
```