SnapAPI · Schema

SnapAPI Text Extraction Response

Visible text content and word count extracted by POST /api/text.

ScreenshotsWebsite ScreenshotsMetadata ExtractionText ExtractionPDF GenerationHeadless ChromiumWeb ScrapingDeveloper ToolsREST

Properties

Name Type Description
data object
usage object
View JSON Schema on GitHub

JSON Schema

snapapi-text-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/snapapi/main/json-schema/snapapi-text-schema.json",
  "title": "SnapAPI Text Extraction Response",
  "description": "Visible text content and word count extracted by POST /api/text.",
  "type": "object",
  "required": ["data"],
  "properties": {
    "data": {
      "type": "object",
      "required": ["url", "text"],
      "properties": {
        "url": { "type": "string", "format": "uri" },
        "title": { "type": "string" },
        "text": { "type": "string", "description": "Visible page text with markup stripped." },
        "word_count": { "type": "integer", "minimum": 0 }
      }
    },
    "usage": {
      "type": "object",
      "properties": {
        "used": { "type": "integer", "minimum": 0 },
        "limit": { "type": "integer", "minimum": 0 }
      }
    }
  }
}