AgentQL · JSON Structure

Agentql Query Document Request Structure

Request body for querying data from a document.

Type: object Properties: 3
AgentsArtificial IntelligenceWeb ScrapingData ExtractionBrowser AutomationREST API

QueryDocumentRequest is a JSON Structure definition published by AgentQL, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

url query prompt

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/agentql/refs/heads/main/json-structure/agentql-query-document-request-structure.json",
  "name": "QueryDocumentRequest",
  "description": "Request body for querying data from a document.",
  "type": "object",
  "properties": {
    "url": {
      "type": "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"
    }
  }
}