API features

Webpage fields from an instruction

Provide a webpage URL and extraction instruction, then receive structured JSON fields for the requested data.

AI agent extraction workflow

Use the response in agents, automations, and RAG pipelines that need clean structured data from public webpages.

Flexible structured results

Describe the fields you need, then validate the extracted JSON for your application. Explicit empty lists represent no matches.

Reduces custom parser work

Avoid writing one-off scrapers for every page layout when your product only needs a specific structured result.

Automation-ready response fields

Return JSON that backend jobs, no-code tools, enrichment workflows, and internal dashboards can consume directly.

Standalone structured extraction API

Subscribe to this interface when the output should be JSON; use fetchcontent when the workflow mainly needs article text.

API Document

HTTP Protocol:HTTPS

HTTP Method:POST

HTTP Endpoint:https://api.gugudata.io/v1/websitetools/url2json

Response Type:application/json; charset=utf-8

DEMO Endpoint:https://api.gugudata.io/v1/websitetools/url2json/demo

Live Demo:Try Interactive Demo

Postman Collection:Run in Postman

API Request Parameters

Name	Type	Is Required	Default Value	Remark
appkey	string	true	YOUR_APPKEY	API key used to authenticate the request.
url	string	true		Public HTTP or HTTPS webpage URL to extract from.
prompt	string	true		Describe the fields to extract. Returned fields depend on your instruction and the page content.

API Response Parameters

Name	Type	Remark
dataStatus	object	Response metadata returned by the current v1 contract.
dataStatus.requestParameter	string	Privacy-safe summary of the normalized request.
dataStatus.statusCode	integer	Application-level status code.
dataStatus.status	string	Application-level result status.
dataStatus.statusDescription	string	Human-readable application status message.
dataStatus.responseDateTime	string	Time at which the response was generated.
dataStatus.dataTotalCount	integer	Number of matching or returned records for this request.
data	object	Dynamic JSON object. Article arrays are wrapped in articles; other arrays in items. Explicit empty lists are valid no-match results. Empty content returns HTTP 422, invalid extraction responses HTTP 502, and unavailable service HTTP 503; these failures use business code 500.

API Response Status Codes

Status Code	Explanation of Status Code	Remarks
200	Request processed successfully.	Some endpoints expose a separate application-level status field in the response body, such as `dataStatus.statusCode`.
400	Invalid request parameters or request format.	Check required fields, data types, and request body format.
401	Missing or unknown application key.	Provide a valid `appkey` with the request.
403	The application key is recognized but access is not allowed.	The key may be expired, inactive, or not permitted for the requested API.
429	Request rate or trial usage limit exceeded.	Reduce request frequency and retry with backoff. If a trial allowance is exhausted, check Trial Keys for remaining requests and subscribe to continue.
500	Internal service error.	Retry later or contact support if the error persists.
503	Upstream service unavailable.	Retry later; the requested upstream dependency is temporarily unavailable.

Remote MCP

AI client access

Use this API through GuGuData Remote MCP

Connect your AI client once, authorize in the browser, and the client can use the GuGuData API tools available to your account. You do not need to paste an appkey into the MCP client.

Endpoint https://mcp.gugudata.io/mcp

Open MCP Guide

Generic MCP configuration

{
  "mcpServers": {
    "gugudata": {
      "url": "https://mcp.gugudata.io/mcp",
      "transportType": "streamable-http"
    }
  }
}

Code Snippets

Run in Postman Open LLM Page

Frequently asked questions

Common questions about request limits, trials, renewal, and cancellation.

What does the 5 requests per second limit mean?

It is a request-rate limit, not a concurrency allowance. Keep your request rate at or below 5 per second. If the service returns a rate-limit response, reduce the frequency and retry with backoff.

Is total paid usage limited?

There is no total request cap during an active paid subscription and no usage-based overage charge.

How does the free trial work?

Each account can receive a limited trial key. Requests are shared across APIs in the same category. Check Trial Keys for the exact allowance and remaining requests.

How do renewal and cancellation work?

The plan renews annually until canceled. Manage or cancel the renewal from Dashboard → Orders & Billing. Access continues through the paid period after cancellation. See the Terms of Service for the current refund policy. If the billing portal is unavailable, contact support.

Technical support

Need help choosing an API or getting started?

[email protected]

Service terms

Read our service terms and privacy policy before subscribing.