HTML to PDF

HTML/URL to PDF
Render HTML or a target URL as PDF and return the generated PDF resource metadata defined by the current v1 contract.

Method: POST
Path: /v1/imagerecognition/html2pdf
Demo: https://api.gugudata.io/v1/imagerecognition/html2pdf/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.

type (string, required): Endpoint-specific type selector. Refer to the endpoint description for supported values.

content (string, required): Primary text content processed by the endpoint.

landscape (integer, optional): Whether the generated PDF should use landscape orientation.

Response Fields:

DataStatus.StatusCode (integer, required): Application-level status code 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 (string, required): Primary response payload returned by the endpoint.

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:

100 Normal return: No additional remark.

101 Parameter error: No additional remark.

102 Request frequency limited: Cannot exceed 100 requests per second

103 Account overdue: No additional remark.

104 Incorrect APPKEY: Please check if the passed APPKEY is the value obtained from the developer center

110 Interface response error: No additional remark.

Key Features:

Superior performance conversion efficiency.

Supports converting passed HTML to PDF, supports converting CSS format in HTML.

Supports passing website URL, directly converting page to corresponding PDF file.

The converted PDF provides a permanent storage file address.

Full interface supports HTTPS (TLS v1.0 / v1.1 / v1.2 / v1.3).

Fully compatible with Apple ATS.

National multi-node CDN deployment.

Interface response is extremely fast, and multiple servers build API interface load balancing.

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Bodyapplication/json

Example

{
  "Data": "string",
  "DataStatus": {
    "StatusCode": 0,
    "StatusDescription": "string",
    "ResponseDateTime": "string",
    "DataTotalCount": 0
  }
}

Request

Request Code Samples

Responses