URL to Markdown

Convert Webpage to Markdown
Convert a target webpage into Markdown using the current service transformation pipeline.

Method: POST
Path: /v1/websitetools/url2markdown
Demo: https://api.gugudata.io/v1/websitetools/url2markdown/demo
OpenAPI: https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json

Request Parameters:

appkey (string, required): Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.

url (string, required): Target webpage URL.

Response Fields:

dataStatus (object, required): Response metadata returned by the current v1 contract.

dataStatus.requestParameter (string, required): Normalized request parameters echoed by the service. Sensitive credentials are omitted when available.

dataStatus.statusCode (integer, required): Application-level status code returned by the current v1 contract.

dataStatus.status (string, required): Application-level status enum returned by the current v1 contract.

dataStatus.statusDescription (string, required): Application-level status message returned by the current v1 contract.

dataStatus.responseDateTime (string, required): Response timestamp returned by the current service contract.

dataStatus.dataTotalCount (integer, required): Total number of records that match the request.

data (object, required): Primary response payload returned by the endpoint.

data.result (string, required): Markdown content converted from the webpage

HTTP Status Codes:

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 concurrency or retry after the limit window resets.

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.

Business Status Codes:

200 Normal return: Markdown content successfully generated and returned

400 Parameter error: Invalid or missing required parameters (url cannot be empty or invalid format)

429 Request frequency limited: Cannot exceed 100 requests per second

403 Account in arrears: Payment required to continue using the service

402 APPKEY error: Please check whether the APPKEY passed is obtained from the developer center

500 API response error: Internal server error during Markdown conversion

503 Service unavailable: External service temporarily unavailable

Key Features:

Support converting content from any publicly accessible webpage.

Clean Markdown output with proper formatting and structure.

Preserves links, images, and text formatting from original webpage.

Automatic URL validation and error handling.

Perfect for documentation, content migration, and text analysis.

Full API support for HTTPS (TLS v1.0 / v1.1 / v1.2 / v1.3).

Fully compatible with Apple ATS.

Nationwide multi-node CDN deployment.

Ultra-fast response, API interface load balancing built with multiple servers.

Details:
https://gugudata.io/details/url2markdown

application/json

Bodyapplication/json

Example

{
  "dataStatus": {
    "statusCode": 0,
    "status": "string",
    "statusDescription": "string",
    "responseDateTime": "string",
    "dataTotalCount": 0
  },
  "data": {
    "result": "string"
  },
  "DataStatus": {
    "StatusCode": 100,
    "StatusDescription": "OK",
    "ResponseDateTime": "2026-01-01 00:00:00",
    "DataTotalCount": 1
  }
}

Request

Request Code Samples

Responses