AgentQL · Schema

QueryDocumentRequest

Request body for querying data from a document.

AgentsArtificial IntelligenceWeb ScrapingData ExtractionBrowser AutomationREST API

Properties

Name Type Description
url string URL of the document to query (PDF or image).
query string AgentQL query string for structured data extraction.
prompt string Natural language description of the data to extract.
View JSON Schema on GitHub

JSON Schema

agentql-query-document-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-document-request-schema.json",
  "title": "QueryDocumentRequest",
  "description": "Request body for querying data from a document.",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL of the document to query (PDF or image).",
      "example": "https://example.com/invoice.pdf"
    },
    "query": {
      "type": "string",
      "description": "AgentQL query string for structured data extraction.",
      "example": "{ invoice { total_amount vendor_name date } }"
    },
    "prompt": {
      "type": "string",
      "description": "Natural language description of the data to extract.",
      "example": "Extract invoice totals and vendor information"
    }
  }
}