Documentation for PdfGen Public API
Cloud-based PDF generation API. Create, manage, and render PDF templates programmatically.
Authentication
All API requests require an API key. Pass it in the Api-Key header:
Api-Key: pk_your_api_key_here
Generate and manage your API keys from your account settings.
Base URL
https://app.generator.rest/api
Swagger UI available at
Documentation for API Endpoints
All URIs are relative to /api
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DocumentsApi | delete | DELETE /documents/{lookup} | Delete document(s) by name |
| DocumentsApi | list | GET /documents | List documents |
| DocumentsApi | retrieve | GET /documents/{key} | Download a document |
| PdfTemplateApi | create | POST /pdf-template | Create a template |
| PdfTemplateApi | createFiles | POST /pdf-template/{id}/files | Upload template files |
| PdfTemplateApi | createFromZip | POST /pdf-template/from-zip | Create template from ZIP |
| PdfTemplateApi | deleteFile | DELETE /pdf-template/{id}/files/{file} | Delete a file |
| PdfTemplateApi | destroy | DELETE /pdf-template/{lookup} | Delete a template |
| PdfTemplateApi | exportAsZip | GET /pdf-template/{id}/files/export-zip | Export template files as ZIP archive |
| PdfTemplateApi | getContextSchema | GET /pdf-template/{id}/context-schema | Get JSON schema for template variables |
| PdfTemplateApi | getDefaultValues | GET /pdf-template/{id}/variables-default-values | Get template variable default values |
| PdfTemplateApi | getFileContent | GET /pdf-template/{id}/files/content/{file} | Download file content |
| PdfTemplateApi | getFileType | GET /pdf-template/{id}/files/type/{file} | Get file type |
| PdfTemplateApi | importZip | POST /pdf-template/{id}/files/import-zip | Upload files from ZIP |
| PdfTemplateApi | list | GET /pdf-template | List templates |
| PdfTemplateApi | listFiles | GET /pdf-template/{id}/files | List template files |
| PdfTemplateApi | render | POST /pdf-template/render | Render a PDF |
| PdfTemplateApi | replace | PUT /pdf-template/{lookup} | Replace a template |
| PdfTemplateApi | retrieve | GET /pdf-template/{lookup} | Get a template |
| PdfTemplateApi | update | PATCH /pdf-template/{lookup} | Update a template |
| TemplateVariablesApi | create | POST /template-variables | Create a variable |
| TemplateVariablesApi | destroy | DELETE /template-variables/{lookup} | Delete a variable |
| TemplateVariablesApi | list | GET /template-variables | List template variables |
| TemplateVariablesApi | replace | PUT /template-variables/{lookup} | Replace a variable |
| TemplateVariablesApi | retrieve | GET /template-variables/{lookup} | Get a variable |
| TemplateVariablesApi | update | PATCH /template-variables/{lookup} | Update a variable |
Documentation for Models
- CreatePdfTemplateDto
- CreatePdfTemplateDto_defaults
- CreateTemplateVariableDto
- ErrorResponse
- FileListResultDto
- FileListResultDto_entries_inner
- HttpErrorDto
- ListDocumentsResponseDto
- ListDocumentsResponseDto_entries_inner
- ListDocumentsResponseDto_entries_inner_template
- Margin
- Organization
- PdfMetadata
- PdfMetadataInfo
- PdfMetadataXmp
- PdfTemplate
- PdfTemplateListResponseDto
- PdfTemplateUserProperties
- RenderPdfResultDto
- RenderPdfTemplateDto
- TemplateFile
- TemplateFilesResponseDto
- TemplateVariable
- TemplateVariableDataOptions
- TemplateVariableListResponseDto
- UpdatePdfTemplateDto
- UpdateTemplateVariableDto
- getContextSchema_200_response
- getDefaultValues_200_response
Documentation for Authorization
api-key
- Type: API key
- API key parameter name: Api-Key
- Location: HTTP header