Zyte API

Access Zyte API from chat — extract structured data from URLs, inspect service health, and review incidents or maintenance windows.

This skill uses ClawLink for hosted connection flows and credentials so you do not need to configure Zyte API access yourself.

Setup in 3 Steps

How It Works

┌─────────────────┐     ┌──────────────┐     ┌──────────────────┐
│   OpenClaw      │────▶│   ClawLink   │────▶│    Zyte API       │
│   (User Chat)   │     │   (Credentials)│   │  (Scraping)      │
└─────────────────┘     └──────────────┘     └──────────────────┘
          │                       │                       │
          │  1. Install Plugin    │                       │
          │  2. Pair Device       │                       │
          │  3. Connect Zyte       │                       │
          │                       │  4. Proxy Requests │
          │                       │  5. Route Through │
          │                       │                       │
          ▼                       ▼                       ▼
    ┌──────────┐           ┌──────────┐           ┌──────────┐
    │  SKILL   │           │ Dashboard│           │  Zyte   │
    │  File    │           │ Auth     │           │ Portal │
    └──────────┘           └──────────┘           └──────────┘

Install

Install the verified ClawLink plugin from ClawHub. After the user confirms, complete the full setup so ClawLink tools are visible in the next OpenClaw chat.

openclaw plugins install clawhub:clawlink-plugin
openclaw config set tools.alsoAllow '["clawlink-plugin"]' --strict-json
openclaw gateway restart

Then tell the user: "OpenClaw has been restarted. Send /new as a standalone message to start a fresh chat, then ask for Zyte API again."

Quick Start

# List integrations
clawlink_list_integrations

# List Zyte API tools
clawlink_list_tools --integration zyte-api

# Search for a specific tool
clawlink_search_tools --query "extract" --integration zyte-api

Authentication

All Zyte API tool calls are authenticated automatically by ClawLink using the user's connected Zyte API credentials.

No API key is required in chat. ClawLink stores the credentials securely and injects them into every Zyte API request on the user's behalf.

Getting Connected

Install the ClawLink plugin (see Install above).
Pair the plugin with clawlink_begin_pairing if it is not configured yet.
Open https://claw-link.dev/dashboard?add=zyte-api and connect Zyte API.
Call clawlink_list_integrations to verify the connection is active.

Connection Management

List Connections

clawlink_list_integrations

Response: Returns all connected integrations. Look for zyte-api in the list.

Verify Connection

clawlink_list_tools --integration zyte-api

Response: Returns the live tool catalog for Zyte API.

Reconnect

If Zyte API tools are missing or the connection shows an error:

Direct the user to https://claw-link.dev/dashboard?add=zyte-api
After they confirm, call clawlink_list_integrations to verify
Then call clawlink_list_tools --integration zyte-api

Discovery Workflow

Call clawlink_list_integrations to confirm Zyte API is connected.
Call clawlink_list_tools --integration zyte-api to see the live catalog.
Treat the returned list as the source of truth. Do not guess or assume what tools exist.
If the user describes a capability but the exact tool is unclear, call clawlink_search_tools with a short query and integration zyte-api.
If no Zyte API tools appear, direct the user to https://claw-link.dev/dashboard?add=zyte-api.

Execution Workflow

┌─────────────────────────────────────────────────────────────┐
│  READ OPERATIONS (Safe)                                     │
│  list → get → search → describe → call                      │
│                                                             │
│  Example: Check status → Extract data → Return results     │
└─────────────────────────────────────────────────────────────┘
                               │
                               ▼
┌─────────────────────────────────────────────────────────────┐
│  WRITE OPERATIONS (Require Confirmation)                    │
│  list → get → describe → preview → confirm → call           │
│                                                             │
│  Example: Describe tool → Preview changes → User approves   │
│           → Execute extraction │
└─────────────────────────────────────────────────────────────┘

For unfamiliar tools, ambiguous requests, or any write action, call clawlink_describe_tool first.
Use the returned guidance, schema, whenToUse, askBefore, safeDefaults, examples, and followups to shape the call.
Prefer targeted extraction and status checks before broad or repeated scraping requests.
For writes or anything marked as requiring confirmation, call clawlink_preview_tool first.
Execute with clawlink_call_tool. Pass confirmation only after the preview matches the user's intent.
If the tool call fails, report the real error. Do not invent results or restate the failure as a missing capability unless the live catalog supports that conclusion.

Tool Reference

Extraction

| Tool | Description | Mode | |------|-------------|------| | zyte_api_extract | Extract structured data from a URL | Read | | zyte_api_extract_batch | Extract data from multiple URLs | Read | | zyte_api_scrape | Scrape a webpage with browser rendering | Read |

Service Health

| Tool | Description | Mode | |------|-------------|------| | zyte_api_get_status | Check Zyte API service status | Read | | zyte_api_list_incidents | List active and recent incidents | Read | | zyte_api_list_maintenance | List scheduled maintenance windows | Read |

Account& Usage

| Tool | Description | Mode | |------|-------------|------| | zyte_api_get_usage | Get current API usage statistics | Read | | zyte_api_get_account | Get account details and plan info | Read |

Code Examples

Extract data from a URL

clawlink_call_tool --tool "zyte_api_extract" \
  --params '{
    "url": "https://example.com/products",
    "follow_redirects": true,
    "browser_html": true
  }'

Check service status

clawlink_call_tool --tool "zyte_api_get_status" \
  --params '{}'

List recent incidents

clawlink_call_tool --tool "zyte_api_list_incidents" \
  --params '{
    "status": "open"
  }'

Batch extraction

clawlink_call_tool --tool "zyte_api_extract_batch" \
  --params '{
    "urls": [
      "https://example.com/page1",
      "https://example.com/page2",
      "https://example.com/page3"
    ]
  }'

Security & Permissions

Access is scoped to the connected Zyte API account's subscription.
All extraction operations require explicit user confirmation for high-volume or repeated scraping.
Respect robots.txt and website terms of service when scraping.
Do not use Zyte API for illegal scraping or unauthorized data extraction.
Cost-sensitive operations (large batch jobs) require extra scrutiny before execution.

Notes

Zyte API handles JavaScript rendering automatically via smart proxy technology.
Rate limits and quotas depend on the subscription plan.
Some websites may block scraping requests; Zyte API's proxy rotation helps but cannot guarantee access.
When extracting from many URLs, consider batching to reduce API calls.

Error Handling

| Status / Error | Meaning | |----------------|---------| | Tool not found | The tool name does not exist in the current catalog. Verify with clawlink_list_tools --integration zyte-api. | | Missing connection | Zyte API is not connected. Direct the user to https://claw-link.dev/dashboard?add=zyte-api. | | extraction_failed | The URL could not be extracted. Check the URL or try with browser_html enabled. | | quota_exceeded | API quota limit reached. Wait or upgrade the plan. | | website_blocked | The website blocked the request. Try a different approach. | | Write rejected | User did not confirm a write action. Always confirm before executing writes. |

Troubleshooting: Tools Not Visible

Check that the ClawLink plugin is installed:
```
openclaw plugins list
```
If the plugin is installed but tools are missing, tell the user to send /new as a standalone message to reload the catalog.

If a fresh chat does not help, run:

openclaw config set tools.alsoAllow '["clawlink-plugin"]' --strict-json
openclaw gateway restart

After restart, tell the user to send /new again and retry.

Troubleshooting: Extraction Failures

Verify the URL is publicly accessible.
Try enabling browser_html for JavaScript-rendered pages.
Check if the website blocks scraping and adjust approach accordingly.
For persistent failures, check Zyte API service status for outages.

Resources

Zyte API Documentation
Zyte API Overview
ClawLink: https://claw-link.dev/?utm_source=clawhub&utm_medium=referral&utm_content=zyte-api-scraping
ClawLink Docs: https://docs.claw-link.dev/openclaw
ClawLink Verification: https://claw-link.dev/verify