ApiIndex

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/everypage-co/json-schema/everypage-co-api-index-schema.json",
  "title": "ApiIndex",
  "description": "The zero-auth discovery document served at GET /api/v1.",
  "x-generated": "2026-11-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/everypage-openapi.json#/components/schemas/ApiIndex",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "version": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "openapi": {
      "type": "string",
      "format": "uri"
    },
    "documentation": {
      "type": "string",
      "format": "uri"
    },
    "authentication": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "api_keys": {
          "type": "string",
          "format": "uri",
          "description": "Where to create a self-serve API key."
        },
        "oauth_metadata": {
          "type": "string",
          "format": "uri",
          "description": "RFC 8414 authorization-server metadata."
        },
        "resource_metadata": {
          "type": "string",
          "format": "uri",
          "description": "RFC 9728 protected-resource metadata for /api/v1."
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "rate_limit": {
      "type": "object",
      "properties": {
        "requests_per_minute": {
          "type": "integer"
        },
        "headers": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "errors": {
      "type": "string"
    },
    "versioning": {
      "type": "string",
      "format": "uri"
    },
    "free_plan": {
      "type": "object",
      "properties": {
        "signup": {
          "type": "string",
          "format": "uri"
        },
        "card_required": {
          "type": "boolean"
        },
        "sandbox": {
          "type": "boolean",
          "description": "There is no separate sandbox; use a free account."
        }
      }
    }
  }
}