Export project documentation as PDF
Exports one page, one folder subtree, or the complete ordered project documentation tree. Folder and project exports include a title page and generated table of contents. Unchanged exports reuse the PDF cache.
POST
/projects/documentation/pdfAuthorization
AuthorizationOAuth2 access token · headerrequiredScopes:
api:reador
AuthorizationBearer token (JWT) · headerrequiredRequest body
requiredapplication/jsonprojectIdstringrequiredProject UUID. This field does not accept a project short identifier. Omit rootNodeId to export the complete ordered documentation tree.
rootNodeIdstringPage or folder node UUID. A page exports one page. A folder exports its ordered subtree.
Responses
200Generated or cached PDF file
string400Invalid project or root node UUID, or an export safety limit was exceeded.
errorstring | objectHTTP error name or a structured HTTP exception response.
Show propertiesHide properties
One of:
string
stringobject
objectmessagestring | string[] | objectrequiredError message, validation message list, or request-field validation message map.
Show propertiesHide properties
One of:
string
stringstring[]
Array of
stringstringobject
objectstatusCodenumberrequiredHTTP status code for this response.
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
404The project or selected root node does not exist or is not accessible.
errorstring | objectHTTP error name or a structured HTTP exception response.
Show propertiesHide properties
One of:
string
stringobject
objectmessagestring | string[] | objectrequiredError message, validation message list, or request-field validation message map.
Show propertiesHide properties
One of:
string
stringstring[]
Array of
stringstringobject
objectstatusCodenumberrequiredHTTP status code for this response.
Request
curl -X POST "https://leadtime.app/api/public/projects/documentation/pdf" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectId": "550e8400-e29b-41d4-a716-446655440000",
"rootNodeId": "550e8400-e29b-41d4-a716-446655440001"
}'const response = await fetch("https://leadtime.app/api/public/projects/documentation/pdf", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_ACCESS_TOKEN",
"Content-Type": "application/json"
},
body: JSON.stringify({
"projectId": "550e8400-e29b-41d4-a716-446655440000",
"rootNodeId": "550e8400-e29b-41d4-a716-446655440001"
})
});import requests
response = requests.post(
"https://leadtime.app/api/public/projects/documentation/pdf",
headers={
"Authorization": "Bearer YOUR_ACCESS_TOKEN",
"Content-Type": "application/json"
},
json={
"projectId": "550e8400-e29b-41d4-a716-446655440000",
"rootNodeId": "550e8400-e29b-41d4-a716-446655440001"
},
)Response
"string"{
"error": "string",
"message": "string",
"statusCode": 0
}Unauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions
{
"error": "string",
"message": "string",
"statusCode": 0
}