本文总阅读量:  次 | 文章总字数: 1,598 字

PDF Splitting API Documentation

摘要:PDF Splitting API documentation with endpoint details, request parameters, response fields, HTTP status codes, and integration examples for developers.

关键词:GuGuData.io、数据接口、API 文档、PDF Splitting API、GuGuData PDF Splitting、pdf-splitter API、Document and Image APIs、developer API documentation、PDF Splitting API Documentation

The PDF Splitting API from GuGuData helps developers split an uploaded PDF into smaller documents based on the requested page size and packaging options.

This article is written for developers who want a crawlable, readable reference before integrating the endpoint into a product, data pipeline, internal tool, or technical workflow. The official detail page is https://gugudata.io/details/pdf-splitter.

API details

Item Value
API name PDF Splitting
Category Document and Image APIs
Method POST
Endpoint https://api.gugudata.io/v1/imagerecognition/pdf-splitter
Content type multipart/form-data
Demo endpoint https://api.gugudata.io/v1/imagerecognition/pdf-splitter/demo
Detail page https://gugudata.io/details/pdf-splitter
OpenAPI JSON https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json

When to use this API

  • Split long PDFs into smaller review packages.
  • Prepare upload-sized document chunks for downstream systems.
  • Automate PDF packaging by page count.

Request parameters

This endpoint accepts parameters through the query string plus request body. Keep appkey out of client-side public code and send it only from trusted server-side environments.

Parameter Type Required Default Description
appkey string Yes YOUR_APPKEY Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
page_size integer Yes - Number of pages per split output file.
is_zip boolean Yes false Whether the split PDF output should be packaged as a ZIP archive.
file file Yes - Local file uploaded as multipart form data.

Example request

curl -X POST "https://api.gugudata.io/v1/imagerecognition/pdf-splitter?appkey=YOUR_APPKEY" \
  -F "page_size=5" \
  -F "is_zip=false" \
  -F "file=@./sample.pdf"

Response fields

The response body contains the fields below for successful JSON responses. For binary endpoints, the success response is returned as binary content and JSON is used for error responses.

Field Type Required Description
dataStatus.statusCode integer Yes Application-level status code returned by the API response.
dataStatus.status string Yes Application-level status enum returned by the API response.
dataStatus.statusDescription string Yes Application-level status message returned by the API response.
dataStatus.responseDateTime string Yes Response timestamp returned by the API response.
dataStatus.dataTotalCount integer Yes Total number of records that match the request.
data.uuid string Yes Unique identifier for the split operation
data.num_files integer Yes Number of files generated after splitting
data.pdf_files array<string> Yes Array of URLs to download the split PDF files or ZIP archive

Response example

{
  "dataStatus": {
    "statusCode": 200,
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-10T00:00:00Z",
    "dataTotalCount": 1,
    "status": "SUCCESS"
  },
  "data": {
    "uuid": "sample value",
    "num_files": "sample value",
    "pdf_files": "sample value"
  }
}

HTTP status codes

Use the HTTP status code for transport-level handling. If the response body contains dataStatus.statusCode, treat it as an application-level status field in the JSON payload.

HTTP status Meaning Recommended handling
200 Request processed successfully. Parse the documented response body for the endpoint result.
400 Invalid request parameters or request format. Check required fields, data types, and request body format.
401 Missing or unknown application key. Send a valid appkey with the request.
403 The application key is recognized but access is not allowed. Check subscription, trial state, and endpoint access.
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 when the dependency is available again.

Implementation notes

  • Validate required parameters before sending the request so 400 responses are easier to diagnose.
  • Keep server-side retries conservative for 429, 500, and 503 responses.
  • Cache stable metadata responses when your use case allows it, especially for lookup and directory endpoints.
  • Log the HTTP status code and dataStatus.statusDescription together for easier debugging.
  • Use the demo endpoint for a quick connectivity check, then switch to the authenticated endpoint for production data.

FAQ

Where is the official API detail page?

The official detail page is https://gugudata.io/details/pdf-splitter. It is the best place to review the latest public endpoint information before publishing or integrating.

Should I handle dataStatus.statusCode as the HTTP status code?

No. Use the HTTP status code for request-level behavior such as authentication, permission, rate limiting, and server errors. Use dataStatus.statusCode only as the response body status field when it is present.

Can I use the demo endpoint in production?

No. The demo endpoint is for quick testing and examples. Use the authenticated endpoint with your appkey for production workflows.

For more developer APIs, visit GuGuData.

EOF

转载须以超链接形式标明文章原始出处和作者信息

微信公众号二维码