# Zyte api

```json
{
  "name": "Zyte api",
  "slug": "zyte_api",
  "url": "https://composio.dev/toolkits/zyte_api",
  "markdown_url": "https://composio.dev/toolkits/zyte_api.md",
  "logo_url": "https://logos.composio.dev/api/zyte_api",
  "categories": [
    "data & analytics"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-05-12T10:31:40.678Z"
}
```

![Zyte api logo](https://logos.composio.dev/api/zyte_api)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Zyte api MCP or direct API to extract web data, automate scraping, overcome anti-bot measures, and process dynamic sites through natural language.

## Summary

Zyte API is a powerful web scraping platform that automates data extraction from websites. It seamlessly handles bans, captchas, and dynamic content for reliable, large-scale crawling.

## Categories

- data & analytics

## Toolkit Details

- Tools: 7

## Images

- Logo: https://logos.composio.dev/api/zyte_api

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Zyte Api.
  - Setup:
    - Configure Api Key credentials for Zyte Api.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Check if there are any unresolved Zyte incidents
- List all upcoming scheduled maintenances for Zyte
- Summarize Zyte API service health status
- Get the current status of all Zyte API components

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `ZYTE_API_ACTIVE_SCHEDULED_MAINTENANCES` | Fetch Active Scheduled Maintenances | Retrieves currently active scheduled maintenances that are in 'In Progress' or 'Verifying' state. Use this to check for ongoing maintenance events that may affect Zyte API availability. Returns an empty list if no maintenances are currently active. |
| `ZYTE_API_COMPONENTS` | Zyte API Components | Retrieves 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. |
| `ZYTE_API_EXTRACT_ZYTE_API` | Extract Data from URL | Tool 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. |
| `ZYTE_API_GET_SCHEDULED_MAINTENANCES` | Get scheduled maintenances | Tool 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. |
| `ZYTE_API_GET_UNRESOLVED_INCIDENTS` | Zyte API: Get Unresolved Incidents | Tool to retrieve unresolved incidents from Zyte status API. Use when you need to check currently open incidents. |
| `ZYTE_API_LIST_INCIDENTS` | List Zyte API status incidents | Retrieves 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. |
| `ZYTE_API_STATUS` | Get Zyte API Status Rollup | Retrieves 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. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Zyte api Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Zyte api actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Fetch all unresolved incidents on Zyte API status page.'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Fetch all unresolved incidents on Zyte API status page.'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Zyte api tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Get a summary of Zyte API status')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Get a summary of Zyte API status' }],
  stopWhen: stepCountIs(5)
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Zyte api Integration

- Supports both Zyte api MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Zyte api data

### 2. Managed Auth

- Built-in API key management for Zyte api
- Central place to manage, scope, and revoke Zyte api access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Zyte api
- Scoped, least privilege access to Zyte api resources
- Full audit trail of agent actions to support review and compliance

## Use Zyte api with any AI Agent Framework

Choose a framework you want to connect Zyte api with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/zyte_api/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/zyte_api/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/zyte_api/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/zyte_api/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/zyte_api/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/zyte_api/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/zyte_api/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/zyte_api/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/zyte_api/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/zyte_api/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/zyte_api/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/zyte_api/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/zyte_api/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/zyte_api/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/zyte_api/framework/autogen)

## Related Toolkits

- [Excel](https://composio.dev/toolkits/excel) - Microsoft Excel is a robust spreadsheet application for organizing, analyzing, and visualizing data. It's the go-to tool for calculations, reporting, and flexible data management.
- [21risk](https://composio.dev/toolkits/_21risk) - 21RISK is a web app built for easy checklist, audit, and compliance management. It streamlines risk processes so teams can focus on what matters.
- [Abstract](https://composio.dev/toolkits/abstract) - Abstract provides a suite of APIs for automating data validation and enrichment tasks. It helps developers streamline workflows and ensure data quality with minimal effort.
- [Addressfinder](https://composio.dev/toolkits/addressfinder) - Addressfinder is a data quality platform for verifying addresses, emails, and phone numbers. It helps you ensure accurate customer and contact data every time.
- [Agenty](https://composio.dev/toolkits/agenty) - Agenty is a web scraping and automation platform for extracting data and automating browser tasks—no coding needed. It streamlines data collection, monitoring, and repetitive online actions.
- [Ambee](https://composio.dev/toolkits/ambee) - Ambee is an environmental data platform providing real-time, hyperlocal APIs for air quality, weather, and pollen. Get precise environmental insights to power smarter decisions in your apps and workflows.
- [Ambient weather](https://composio.dev/toolkits/ambient_weather) - Ambient Weather is a platform for personal weather stations with a robust API for accessing local, real-time, and historical weather data. Get detailed environmental insights directly from your own sensors for smarter apps and automations.
- [Anonyflow](https://composio.dev/toolkits/anonyflow) - Anonyflow is a service for encryption-based data anonymization and secure data sharing. It helps organizations meet GDPR, CCPA, and HIPAA data privacy compliance requirements.
- [Api ninjas](https://composio.dev/toolkits/api_ninjas) - Api ninjas offers 120+ public APIs spanning categories like weather, finance, sports, and more. Developers use it to supercharge apps with real-time data and actionable endpoints.
- [Api sports](https://composio.dev/toolkits/api_sports) - Api sports is a comprehensive sports data platform covering 2,000+ competitions with live scores and 15+ years of stats. Instantly access up-to-date sports information for analysis, apps, or chatbots.
- [Apify](https://composio.dev/toolkits/apify) - Apify is a cloud platform for building, deploying, and managing web scraping and automation tools called Actors. It lets you automate data extraction and workflow tasks at scale—no infrastructure headaches.
- [Autom](https://composio.dev/toolkits/autom) - Autom is a lightning-fast search engine results data platform for Google, Bing, and Brave. Developers use it to access fresh, low-latency SERP data on demand.
- [Beaconchain](https://composio.dev/toolkits/beaconchain) - Beaconchain is a real-time analytics platform for Ethereum 2.0's Beacon Chain. It provides detailed insights into validators, blocks, and overall network performance.
- [Big data cloud](https://composio.dev/toolkits/big_data_cloud) - BigDataCloud provides APIs for geolocation, reverse geocoding, and address validation. Instantly access reliable location intelligence to enhance your applications and workflows.
- [Bigpicture io](https://composio.dev/toolkits/bigpicture_io) - BigPicture.io offers APIs for accessing detailed company and profile data. Instantly enrich your applications with up-to-date insights on 20M+ businesses.
- [Bitquery](https://composio.dev/toolkits/bitquery) - Bitquery is a blockchain data platform offering indexed, real-time, and historical data from 40+ blockchains via GraphQL APIs. Get unified, reliable access to complex on-chain data for analytics, trading, and research.
- [Brightdata](https://composio.dev/toolkits/brightdata) - Brightdata is a leading web data platform offering advanced scraping, SERP APIs, and anti-bot tools. It lets you collect public web data at scale, bypassing blocks and friction.
- [Builtwith](https://composio.dev/toolkits/builtwith) - BuiltWith is a web technology profiler that uncovers the technologies powering any website. Gain actionable insights into analytics, hosting, and content management stacks for smarter research and lead generation.
- [Byteforms](https://composio.dev/toolkits/byteforms) - Byteforms is an all-in-one platform for creating forms, managing submissions, and integrating data. It streamlines workflows by centralizing form data collection and automation.
- [Cabinpanda](https://composio.dev/toolkits/cabinpanda) - Cabinpanda is a data collection platform for building and managing online forms. It helps streamline how you gather, organize, and analyze responses.

## Frequently Asked Questions

### Do I need my own developer credentials to use Zyte api with Composio?

Yes, Zyte api requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)