PDF AI Summary API Integration Guide

The GuGuData PDF AI Summary API turns an uploaded document into a concise briefing in the requested language. Use it to review reports, research papers, manuals, and other multi-page PDFs more quickly, then store or display the summary through a predictable JSON response.

Start here: Try the live demo or view the current API details.

API details

Item	Value
API name	PDF AI Summary
Category	Document and Image APIs
Method	`POST`
Endpoint	`https://api.gugudata.io/v1/imagerecognition/pdf-summary`
Content type	`multipart/form-data`
Demo endpoint	https://api.gugudata.io/v1/imagerecognition/pdf-summary/demo
Demo source PDF	Download the reproducible PDF fixture
Detail page	https://gugudata.io/details/pdf-summary
OpenAPI JSON	https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json

When to use this API

Brief support, research, operations, and study teams on long documents.
Triage reports and papers before deciding which sources need a full review.
Add multilingual PDF summaries to knowledge, document, and learning workflows.

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.
`file`	`file`	Yes	-	Local file uploaded as multipart form data.
`lang`	`string`	No	`en`	Language code used by the summarization workflow.

Example request

curl -X POST "https://api.gugudata.io/v1/imagerecognition/pdf-summary?appkey=YOUR_APPKEY" \
  -F "file=@./sample.pdf" \
  -F "lang=en"

You can download the same PDF used by the demo and submit it as 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
`summary`	`string`	Yes	AI-generated summary of the PDF document in the specified language

Response example

{
  "dataStatus": {
    "statusCode": 200,
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-10T00:00:00Z",
    "dataTotalCount": 1
  },
  "data": "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-summary. 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.