Convert Webpage to Markdown LLM Markdown

Back to Details
# Convert Webpage to Markdown

Convert a public webpage into clean, reusable Markdown.

## API Overview

- **HTTP Protocol:** HTTPS
- **HTTP Method:** POST
- **HTTP Endpoint:** https://api.gugudata.io/v1/websitetools/url2markdown
- **Response Type:** application/json; charset=utf-8
- **DEMO Endpoint:** https://api.gugudata.io/v1/websitetools/url2markdown/demo
- **Live Demo:** https://gugudata.io/demo/url2markdown
- **Postman:** https://www.postman.com/gugudata/gugudata-io
- **LLM Page:** https://gugudata.io/details/url2markdown/llm
- **Raw Markdown:** https://gugudata.io/details/url2markdown/llm.md

## Remote MCP

- **MCP Endpoint:** https://mcp.gugudata.io/mcp
- **MCP Guide:** https://gugudata.io/mcp/
- **Authorization:** OAuth authorization opens in the browser; do not paste appkeys into MCP clients.
- **Tool Scope:** MCP clients receive GuGuData API tools available to the authorized account.

## Data & API Features

- Webpage conversion: Turn a public webpage into Markdown with one URL.
- Readable text output: Receive the converted text directly in a JSON response.
- Documentation workflows: Prepare public documentation for review and reuse.
- Knowledge base ingestion: Use Markdown as an input to your own indexing and retrieval workflow.
- Content processing: Pass the returned text to search, classification, or summarization tools.
- A working example: Inspect a conversion of the GuGuData homepage before integrating.

## 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 |  | Target webpage URL. |

## 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 | Primary response payload returned by the endpoint. |
| data.result | string | Markdown content converted from the webpage. |

## 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. |

## cURL Example

```bash
curl --location 'https://api.gugudata.io/v1/websitetools/url2markdown?appkey=YOUR_APPKEY' --request POST --header 'Content-Type: application/json' --data '{
  "url": "YOUR_VALUE"
}'
```