canonical: https://jentic.com/apis/zyte.com/zyte

# Zyte API

Zyte API provides web data extraction capabilities including HTTP responses, browser HTML, screenshots, and automatic data extraction. The API exposes 1 endpoints secured with basic authentication.

## For AI agents

Programmatically extract data from a web page. Covers 1 operations with basic authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Extract data from a web page
- Manage developer tools data programmatically
- Integrate Zyte API into automated workflows
- Query and filter Zyte API records by parameters
- Monitor Zyte API operational status and events

## Use cases

### Developer Tools Operations

Use the Zyte API to perform developer tools operations programmatically. The API provides 1 endpoints covering core functionality including extract data from a web page.

Example prompt: Call POST `/v1/extract` to extract data from a web page

### Data Retrieval and Monitoring

Query Zyte API resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary Zyte API endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call Zyte API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.

Example prompt: Search Jentic for 'extract data from a web page', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/extract` | Extract data from a web page |

## Key resources

- **Extraction** — Operations related to Extraction

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 40 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 90 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 45 / 100
  - Agent Usability: 94 / 100
  - Security: 10 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/zyte.com/zyte/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Zyte API by hand means base-authenticating with your API key against the api.zyte.com host and handling extraction retries yourself. Through Jentic you install once, import Zyte from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** The Zyte target is a URL in the request body of its single extract operation, so limit the agent to the operation it needs: web-page extraction. You choose that operation set, so nothing beyond extraction runs unless you add it.
- **Credential handling:** Your Zyte API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'extract data from a web page', and Jentic returns the matching Zyte operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Zyte API use?

The Zyte API uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I extract data from a web page with the Zyte API?

Yes. Use the POST `/v1/extract` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Zyte API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I extract data from a web page through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'extract data from a web page'. Jentic returns the matching Zyte API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Zyte API have?

The Zyte API exposes 1 endpoints covering extraction operations.

### Can I limit what my agent is allowed to do with the Zyte API?

Yes. Because you run Jentic One yourself, you decide which Zyte operations your agent can call, and the Zyte API exposes a single extract operation, POST `/v1/extract`, that takes the target URL in its request body. You grant your agent only that web-page extraction operation, so it cannot invoke anything else unless you explicitly add it. Your Zyte API key stays with your own Jentic One instance and is injected only when that allowed operation runs, never entering the agent's prompt or context.