AgentQL REST API reference

AgentQL's REST API allows you to query web pages and documents like PDFs and image files to retrieve the results through HTTP requests from any language.

Query data

Extract data from a webpage by sending a URL and an AgentQL query.

curl -X POST https://api.agentql.com/v1/query-data \
  -H "X-API-Key: $AGENTQL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "{ products[] { product_name product_price(integer) } }",
    "url": "https://scrapeme.live/?s=fish&post_type=product",
    "params": {
      "wait_for": 0,
      "is_scroll_to_bottom_enabled": false,
      "mode": "fast",
      "is_screenshot_enabled": false
    }
  }'

{
  "data": {
    "products": [
      {
        "product_name": "Qwilfish",
        "price": 77
      },
      {
        "product_name": "Huntail",
        "price": 52
      },
      ...
    ]
  },
  "metadata": {
    "request_id": "ecab9d2c-0212-4b70-a5bc-0c821fb30ae3"
  }
}

Authentication

All requests to the AgentQL API must include an X-API-Key header with your API key. You can generate an API key through Dev Portal.

Request body for web queries

• query string

  The AgentQL query to execute

• url string

  The URL of the webpage to query

• params object (optional)

  • wait_for number

    Wait time in seconds for page load (max 10 seconds). Defaults to 0.

  • is_scroll_to_bottom_enabled boolean

    Enable/disable scrolling to bottom before snapshot. Defaults to false.

  • mode str

    Specifies the extraction mode: standard for complex or high-volume data, or fast for typical use cases. Defaults to fast. You can read more about the mode options in Guide.

  • is_screenshot_enabled boolean

    Enable/disable screenshot capture. Defaults to false.

Response for web queries

• data object

  Data that matches the query

• metadata object

  • request_id string

    A UUID for the request

  • screenshot string | null

    Base64 encoded screenshot if enabled, null otherwise. You can convert the Base64 string returned in the screenshot field to an image and view it using free online tools like Base64.guru.

Query document

Extract data from a webpage by sending a PDF or image file and an AgentQL query.

curl -X POST https://api.agentql.com/v1/query-document \
  -H "X-API-Key: $AGENTQL_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/file.pdf" \
  -F "query={ products[] { product_name product_price(integer) } }"
  -d " { "params": { "mode": "fast" } }"

{
  "data": {
    "products": [
      {
        "product_name": "Qwilfish",
        "price": 77
      },
      {
        "product_name": "Huntail",
        "price": 52
      },
      ...
    ]
  },
  "metadata": {
    "request_id": "ecab9d2c-0212-4b70-a5bc-0c821fb30ae3"
  }
}

Authentication

All requests to the AgentQL API must include an X-API-Key header with your API key. You can generate an API key through Dev Portal.

Request body for document queries

• query string

  The AgentQL query to execute

• file Buffered Object representation of the file to extract data from

  The file to extract data from

• params object (optional)

  • mode str

    Specifies the extraction mode: standard for complex or high-volume data, or fast for typical use cases. Defaults to fast. You can read more about the mode options in Guide. Only configurable in curl requests.

Response for document queries

• data object

  Data that matches the query

• metadata object

  • request_id string

    A Universally Unique Identifier (UUID) for the request