HypoText

API Documentation

Build with HypoText. Detect AI agents, transform content into optimized JSON, and access analytics—all with a simple, powerful API.

Overview

Base URL:https://api.hypotext.dev/v1
Auth:Bearer Token via Authorization header
Content-Type:application/json
Dashboard:hypotext.dev/dashboard

Authentication

Include your API key in the Authorization header for every request.

Authorization: Bearer <YOUR_API_KEY>

Generate API keys in your Dashboard under Project Settings.

Endpoints

Transform Content

Convert HTML or URLs into optimized JSON for AI/LLMs.

POST /transform

Request

{
  "source": "https://your-website.com/product/123",
  "mode": "url",
  "options": {}
}

Response

{
  "status": "success",
  "meta": {
    "title": "HypoText | Edge Layer",
    "description": "Optimized JSON for AI"
  },
  "content": { ... },
  "ai_readability_score": 99
}

Detect Agent

Identify if a request is from a human or specific bot type.

POST /detect

Request

{
  "user_agent": "Mozilla/5.0 (compatible; Googlebot/2.1)"
}

Response

{
  "is_bot": true,
  "bot_type": "search_crawler",
  "bot_name": "Googlebot",
  "recommended_action": "serve_optimized_json"
}

Analytics

Available for Pro & Enterprise plans.

GET /analytics/summary

Query Parameters

from - Start date (ISO 8601)
to - End date (ISO 8601)

SDKs & Middleware

Use our pre-built integrations for seamless framework integration.

Installation

npm install @hypotext/sdk
Next.js Middleware Guide
React Integration
Vue/Nuxt Plugin

Need help? Contact support@hypotext.dev