{
"success": true,
"url": "https://example.com/",
"truncated_input": false,
"data": {
"category": "technology",
"reason": "The content explicitly mentions 'domain', 'documentation examples', and 'operations', which are technical terms related to web development and internet infrastructure."
},
"usage": {
"input_tokens": 167,
"output_tokens": 39,
"total_tokens": 206
},
"processing_ms": 926
}
curl --location --request POST 'https://zylalabs.com/api/13799/ai+web+page+analysis+api/31646/classify+website+or+text' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"url": "https://example.com",
"categories": [
"technology",
"business",
"news"
]
}'
{
"success": true,
"url": "https://example.com/",
"title": "Example Domain",
"render_mode": "static",
"truncated_input": false,
"data": {
"page_type": "documentation",
"language": "en",
"summary": "The source content describes 'Example Domain', a placeholder used for documentation examples. It explicitly states that permission is not required for its use in examples but advises against using it in operational contexts. The text includes a reference to learn more about this policy.",
"key_points": [
"The domain is intended for use in documentation examples.",
"No permission is needed to use the domain in examples.",
"The domain should be avoided in operational use.",
"A link is provided to learn more about the policy.",
"The content serves as a warning against misuse in production.",
"The text is concise and instructional.",
"It functions as a standard placeholder notice.",
"The domain is not for general public use."
],
"fields": {
"title": "Example Domain",
"category": "documentation"
},
"evidence": [
{
"field": "title",
"quote": "Example Domain"
},
{
"field": "category",
"quote": "documentation examples"
},
{
"field": "key_points",
"quote": "without needing permission"
},
{
"field": "key_points",
"quote": "Avoid use in operations"
},
{
"field": "key_points",
"quote": "Learn more"
}
]
},
"evidence_removed": 0,
"usage": {
"input_tokens": 204,
"output_tokens": 251,
"total_tokens": 455
},
"processing_ms": 6720
}
curl --location --request POST 'https://zylalabs.com/api/13799/ai+web+page+analysis+api/31647/analyze+website+with+ai' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"url": "https://example.com",
"render": "never",
"schema": {
"title": "string",
"category": "string"
},
"max_summary_words": 150
}'
{
"success": true,
"data": {
"url": "https://example.com/",
"title": "Example Domain",
"description": null,
"keywords": null,
"author": null,
"language": null,
"canonical": null,
"og": {
"title": null,
"description": null,
"image": null,
"url": null,
"type": null,
"site_name": null
},
"twitter": {
"card": null,
"title": null,
"description": null,
"image": null
}
},
"processing_ms": 64
}
curl --location --request POST 'https://zylalabs.com/api/13799/ai+web+page+analysis+api/31648/extract+website+metadata' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"url": "https://example.com"
}'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the AI Web Page Analysis API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
Classify and analyze public web pages or supplied text. Extract metadata, summaries, categories, entities, and custom structured JSON from static or JavaScript-rendered content.
The API can classify text or website content, analyze web pages with AI, generate summaries and structured fields, and extract standard website metadata.
Yes. The classification endpoint accepts either a publicly accessible URL or supplied text. Provide exactly one source together with the category labels you want the API to evaluate.
Add between 2 and 50 category labels to the categories array. The API analyzes the supplied content and returns the best matching category with an explanation.
It returns the page title, an AI-generated summary, key points, requested structured fields, supporting evidence, rendering mode, processing time, and token usage.
Yes. Pass a schema object containing up to 20 field names. Each value can specify a supported data type or a concise instruction describing the information to extract.
Yes. Use render="auto" to enable browser rendering when required, render="always" to force it, or render="never" for faster processing of static pages.
The metadata endpoint can return the title, description, keywords, author, language, canonical URL, Open Graph properties, Twitter Card data, and other page metadata.
No. Only publicly accessible HTTP and HTTPS URLs are supported. Private, loopback, link-local, and other restricted network destinations are rejected for security.
Use Classify Website or Text for category assignment, Analyze Website with AI for summaries and custom structured extraction, and Extract Website Metadata for fast non-AI metadata lookup.
Subscribe to the API and include your Zyla access key in the Authorization header using the Bearer scheme. The code examples in the API documentation include the required header.
The Classify Website or Text endpoint returns the category and reasoning for classification. The Analyze Website with AI endpoint provides a summary, key points, and structured data. The Extract Website Metadata endpoint retrieves metadata such as title, description, keywords, and Open Graph properties.
Key fields include "success" (indicating request status), "url" (the analyzed page), "data" (containing summaries, categories, or metadata), and "processing_ms" (time taken for processing). Each endpoint has specific fields relevant to its function.
Response data is structured in JSON format. Each endpoint returns a "success" boolean, followed by relevant data in a "data" object. For example, the Analyze Website with AI endpoint includes fields like "summary," "key_points," and "page_type" within the "data" object.
Parameters vary by endpoint. For Classify Website or Text, provide "text" or "url" and "categories." For Analyze Website with AI, include "url" and an optional "schema." The Extract Website Metadata endpoint requires only the "url" parameter.
Users can customize requests by specifying category labels in the classification endpoint and defining a schema object with field names for the analysis endpoint. This allows tailored extraction of specific data types or categories.
Typical use cases include content categorization for automated tagging, generating summaries for quick insights, and extracting metadata for SEO analysis. Businesses can leverage this data for content management and digital marketing strategies.
Data accuracy is maintained through AI algorithms that analyze content contextually. The API uses advanced natural language processing techniques to ensure reliable classification and summarization based on the latest web content.
If results are partial or empty, check the input URL or text for accessibility and content richness. The API may return null values for fields if the requested data is not present on the page, indicating a need for alternative sources or inputs.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund