Skip to main content
Zyte Api logo
  • Category: ai web scraping
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 7
  • Triggers: 0
  • Slug: ZYTE_API
  • Version: 20261101_00

Tools

Slug: ZYTE_API_ACTIVE_SCHEDULED_MAINTENANCESFetches active scheduled maintenances from the Zyte status page to check for ongoing events that may affect service availability. Returns an empty list when no active maintenances are reported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZYTE_API_COMPONENTSRetrieves all Zyte service components with their current operational status. Returns component details including status (operational, degraded_performance, partial_outage, major_outage), descriptions, groupings, and metadata. Useful for monitoring service health and identifying issues. No parameters required - provides a real-time snapshot of all Zyte infrastructure components.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZYTE_API_EXTRACT_ZYTE_APITool to extract data from URLs using Zyte API’s HTTP, browser, and AI-powered extraction capabilities. Use when you need to scrape web pages, extract structured data (products, articles, jobs, etc.), capture screenshots, or perform browser automation. Supports geolocation targeting and custom extraction schemas.

Input Parameters

string
required
Absolute URL to extract data from. Max 8192 characters. Host must be a domain name, not IP address.
boolean
Set to true to extract search engine results page data. Cannot combine with other extraction types.
object
Arbitrary key-value pairs for filtering in Stats API
string
Scrapy Cloud job ID
string ("datacenter" | "residential")
Type of IP address to use for the request
array
Browser actions to execute before extraction (click, scroll, type, wait, etc.)
boolean
Set to true to extract structured article data using AI
boolean
Set to true to extract structured product data using AI
object
Arbitrary data to be echoed back in response
boolean
Enable JavaScript execution for browser requests
boolean
Set to true to extract structured job posting data
boolean
Set to true to get a screenshot of the page. Can combine with browserHtml or AI extraction.
boolean
Set to true to extract list of articles
boolean
Set to true to get browser-rendered HTML. Not compatible with httpResponseBody.
boolean
Set to true to extract structured forum thread data
string
Two-letter country code for geolocation targeting (e.g. US, GB)
boolean
Set to true to extract general page content text
boolean
Set to true to extract list of products from category page
object
Options for SERP extraction
object
Common options for data extraction
array
Capture network requests matching URL patterns. Each item has url and optional filterHeaders.
object
Common options for data extraction
array
Cookies to send with the request
object
Browser request headers
array
Session context for maintaining state across requests
string
Base64-encoded data to send as request body. Max 400000 characters.
string
UTF-8 text to send as request body. Alternative to httpRequestBody.
object
Define custom attributes to extract using natural language descriptions
boolean
Set to true to get HTTP response body (base64-encoded). Not compatible with browser automation.
boolean
Set to true to extract article navigation links
string ("GET" | "POST" | "PUT" | "DELETE" | "OPTIONS" | "TRACE" | "PATCH" | "HEAD")
HTTP methods for the target request
boolean
Set to true to extract product navigation links
object
Options for screenshot capture
object
Common options for data extraction
boolean
Set to true to get HTTP response headers
boolean
Set to true to extract job posting navigation links
object
Options for custom attributes extraction
array
Custom HTTP request headers

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZYTE_API_GET_SCHEDULED_MAINTENANCESTool to get the 50 most recent scheduled maintenances (upcoming and completed) from Zyte status API. Use after confirming you need the latest maintenance schedule for monitoring.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZYTE_API_GET_UNRESOLVED_INCIDENTSTool to retrieve unresolved incidents from Zyte status API. Use when you need to check currently open incidents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZYTE_API_LIST_INCIDENTSRetrieves the 50 most recent incidents from the Zyte API status page, including both resolved and unresolved incidents. Use this tool to check current API health, review incident history, or get detailed information about service disruptions affecting Zyte services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZYTE_API_STATUSRetrieves comprehensive operational status for all Zyte services. Returns current status of components (Zyte API, Smart Proxy Manager, Scrapy Cloud, etc.), active incidents, and scheduled maintenance windows. Use this to check service health before making API calls or to diagnose issues.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not