AgentQL · Schema

QueryDataRequest

Request body for querying data from a web page.

AgentsArtificial IntelligenceWeb ScrapingData ExtractionBrowser AutomationREST API

Properties

Name Type Description
url string The URL of the web page to query.
html string Raw HTML content to query instead of a URL.
query string AgentQL query string for structured data extraction.
prompt string Natural language description of the data to extract (alternative to query).
params object
View JSON Schema on GitHub

JSON Schema

agentql-query-data-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/agentql/refs/heads/main/json-schema/agentql-query-data-request-schema.json",
  "title": "QueryDataRequest",
  "description": "Request body for querying data from a web page.",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the web page to query.",
      "example": "https://news.ycombinator.com"
    },
    "html": {
      "type": "string",
      "description": "Raw HTML content to query instead of a URL.",
      "example": "<html><body><h1>Hello World</h1></body></html>"
    },
    "query": {
      "type": "string",
      "description": "AgentQL query string for structured data extraction.",
      "example": "{ posts[] { title link score } }"
    },
    "prompt": {
      "type": "string",
      "description": "Natural language description of the data to extract (alternative to query).",
      "example": "Extract the top 10 posts with their titles, links, and scores"
    },
    "params": {
      "$ref": "#/components/schemas/QueryParams"
    }
  }
}