pagespool 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pagespool-1.0.0/PKG-INFO +126 -0
- pagespool-1.0.0/README.md +117 -0
- pagespool-1.0.0/pagespool/__init__.py +8 -0
- pagespool-1.0.0/pagespool/api/__init__.py +1 -0
- pagespool-1.0.0/pagespool/api/account/__init__.py +1 -0
- pagespool-1.0.0/pagespool/api/account/get_me.py +176 -0
- pagespool-1.0.0/pagespool/api/docling/__init__.py +1 -0
- pagespool-1.0.0/pagespool/api/docling/docling_convert_file.py +255 -0
- pagespool-1.0.0/pagespool/api/docling/docling_convert_file_async.py +232 -0
- pagespool-1.0.0/pagespool/api/docling/docling_convert_source.py +253 -0
- pagespool-1.0.0/pagespool/api/docling/docling_convert_source_async.py +234 -0
- pagespool-1.0.0/pagespool/api/docling/docling_result.py +196 -0
- pagespool-1.0.0/pagespool/api/docling/docling_status_poll.py +184 -0
- pagespool-1.0.0/pagespool/api/epub_check/__init__.py +1 -0
- pagespool-1.0.0/pagespool/api/epub_check/epubcheck_check.py +260 -0
- pagespool-1.0.0/pagespool/api/gotenberg/__init__.py +1 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_chromium_convert_html.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_chromium_convert_markdown.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_chromium_convert_url.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_chromium_screenshot_html.py +227 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_chromium_screenshot_markdown.py +227 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_chromium_screenshot_url.py +227 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_health.py +148 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_libreoffice_convert.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_attach.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_attachments.py +237 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_autotag.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_bookmarks.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_compose.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_convert_colors.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_decrypt.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_delete.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_detach.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_encrypt.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_extract_attachments.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_extract_text.py +231 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_flatten_form.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_flatten_transparency.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_form.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_info.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_insert.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_merge.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_metadata.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_optimize.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_pipe.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_redact.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_remediate.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_render.py +223 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_rotate.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_select.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_set_bookmarks.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_set_form.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_set_metadata.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_sign.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_split.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_stamp_image.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_stamp_pdf.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_stamp_text.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_timestamp.py +229 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_pdf_validate.py +233 -0
- pagespool-1.0.0/pagespool/api/gotenberg/gotenberg_version.py +138 -0
- pagespool-1.0.0/pagespool/api/jobs/__init__.py +1 -0
- pagespool-1.0.0/pagespool/api/jobs/get_job.py +189 -0
- pagespool-1.0.0/pagespool/api/jobs/list_jobs.py +211 -0
- pagespool-1.0.0/pagespool/api/mark_it_down/__init__.py +1 -0
- pagespool-1.0.0/pagespool/api/mark_it_down/markitdown_convert.py +242 -0
- pagespool-1.0.0/pagespool/api/oc_rmy_pdf/__init__.py +1 -0
- pagespool-1.0.0/pagespool/api/oc_rmy_pdf/ocrmypdf_get_result.py +211 -0
- pagespool-1.0.0/pagespool/api/oc_rmy_pdf/ocrmypdf_submit.py +259 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/__init__.py +1 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_get_profile.py +194 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_info.py +157 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_list_profiles.py +153 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_1a.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_1b.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_2a.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_2b.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_2u.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_3a.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_3b.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_3u.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_4.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_4e.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_4f.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_auto.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_ua1.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_ua2.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_wt1a.py +231 -0
- pagespool-1.0.0/pagespool/api/vera_pdf/verapdf_validate_wt1r.py +231 -0
- pagespool-1.0.0/pagespool/api/weasy_print/__init__.py +1 -0
- pagespool-1.0.0/pagespool/api/weasy_print/weasyprint_render.py +277 -0
- pagespool-1.0.0/pagespool/client.py +268 -0
- pagespool-1.0.0/pagespool/errors.py +16 -0
- pagespool-1.0.0/pagespool/models/__init__.py +251 -0
- pagespool-1.0.0/pagespool/models/body_docling_convert_file.py +618 -0
- pagespool-1.0.0/pagespool/models/body_docling_convert_file_async.py +618 -0
- pagespool-1.0.0/pagespool/models/body_epubcheck_check.py +75 -0
- pagespool-1.0.0/pagespool/models/body_markitdown_convert.py +75 -0
- pagespool-1.0.0/pagespool/models/body_ocrmypdf_submit.py +162 -0
- pagespool-1.0.0/pagespool/models/body_ocrmypdf_submit_language.py +11 -0
- pagespool-1.0.0/pagespool/models/body_ocrmypdf_submit_mode.py +10 -0
- pagespool-1.0.0/pagespool/models/body_ocrmypdf_submit_output_type.py +9 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_1a.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_1b.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_2a.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_2b.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_2u.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_3a.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_3b.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_3u.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_4.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_4e.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_4f.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_auto.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_ua_1.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_ua_2.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_wt_1a.py +75 -0
- pagespool-1.0.0/pagespool/models/body_verapdf_validate_wt_1r.py +75 -0
- pagespool-1.0.0/pagespool/models/check_report.py +156 -0
- pagespool-1.0.0/pagespool/models/check_report_checker.py +47 -0
- pagespool-1.0.0/pagespool/models/check_report_items_item.py +45 -0
- pagespool-1.0.0/pagespool/models/check_report_messages_item.py +45 -0
- pagespool-1.0.0/pagespool/models/check_report_publication.py +47 -0
- pagespool-1.0.0/pagespool/models/convert_document_response.py +161 -0
- pagespool-1.0.0/pagespool/models/convert_document_response_confidence_type_0.py +45 -0
- pagespool-1.0.0/pagespool/models/convert_document_response_errors_item.py +45 -0
- pagespool-1.0.0/pagespool/models/convert_document_response_timings.py +45 -0
- pagespool-1.0.0/pagespool/models/convert_options.py +422 -0
- pagespool-1.0.0/pagespool/models/convert_source_request.py +167 -0
- pagespool-1.0.0/pagespool/models/convert_source_request_target_type_0.py +45 -0
- pagespool-1.0.0/pagespool/models/credits_info.py +95 -0
- pagespool-1.0.0/pagespool/models/export_document.py +202 -0
- pagespool-1.0.0/pagespool/models/export_document_json_content_type_0.py +45 -0
- pagespool-1.0.0/pagespool/models/file_source.py +80 -0
- pagespool-1.0.0/pagespool/models/gotenberg_chromium_convert_html_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_chromium_convert_markdown_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_chromium_convert_url_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_chromium_screenshot_html_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_chromium_screenshot_markdown_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_chromium_screenshot_url_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_libreoffice_convert_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_attach_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_attachments_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_attachments_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_autotag_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_bookmarks_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_bookmarks_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_compose_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_convert_colors_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_decrypt_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_delete_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_detach_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_encrypt_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_extract_attachments_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_extract_text_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_flatten_form_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_flatten_transparency_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_form_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_form_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_info_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_info_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_insert_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_merge_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_metadata_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_metadata_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_optimize_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_pipe_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_redact_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_remediate_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_render_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_rotate_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_select_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_set_bookmarks_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_set_form_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_set_metadata_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_sign_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_split_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_stamp_image_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_stamp_pdf_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_stamp_text_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_timestamp_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_validate_body.py +89 -0
- pagespool-1.0.0/pagespool/models/gotenberg_pdf_validate_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/http_source.py +96 -0
- pagespool-1.0.0/pagespool/models/http_source_headers.py +47 -0
- pagespool-1.0.0/pagespool/models/job_response.py +230 -0
- pagespool-1.0.0/pagespool/models/job_response_page.py +97 -0
- pagespool-1.0.0/pagespool/models/job_response_result_type_0.py +45 -0
- pagespool-1.0.0/pagespool/models/mark_it_down_convert_response.py +87 -0
- pagespool-1.0.0/pagespool/models/mark_it_down_convert_response_meta.py +47 -0
- pagespool-1.0.0/pagespool/models/me_response.py +135 -0
- pagespool-1.0.0/pagespool/models/ocr_job_response.py +102 -0
- pagespool-1.0.0/pagespool/models/problem.py +190 -0
- pagespool-1.0.0/pagespool/models/problem_errors_type_0_item.py +45 -0
- pagespool-1.0.0/pagespool/models/rate_limit_info.py +118 -0
- pagespool-1.0.0/pagespool/models/summary.py +86 -0
- pagespool-1.0.0/pagespool/models/task_status.py +163 -0
- pagespool-1.0.0/pagespool/models/task_status_task_meta_type_0.py +45 -0
- pagespool-1.0.0/pagespool/models/task_status_task_status.py +11 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_1a_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_1b_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_2a_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_2b_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_2u_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_3a_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_3b_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_3u_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_4_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_4e_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_4f_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_auto_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_ua_1_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_ua_2_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_wt_1a_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/verapdf_validate_wt_1r_response_200.py +45 -0
- pagespool-1.0.0/pagespool/models/weasy_print_render_request.py +108 -0
- pagespool-1.0.0/pagespool/models/weasy_print_render_request_pdf_variant_type_0.py +9 -0
- pagespool-1.0.0/pagespool/py.typed +1 -0
- pagespool-1.0.0/pagespool/types.py +54 -0
- pagespool-1.0.0/pyproject.toml +29 -0
- pagespool-1.0.0/pyproject.toml.orig +25 -0
pagespool-1.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: pagespool
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: A client library for accessing pagespool
|
|
5
|
+
Requires-Dist: httpx2>=2.13.1,<3
|
|
6
|
+
Requires-Dist: attrs>=22.2.0
|
|
7
|
+
Requires-Python: >=3.11
|
|
8
|
+
Description-Content-Type: text/markdown
|
|
9
|
+
|
|
10
|
+
# pagespool — Python SDK
|
|
11
|
+
|
|
12
|
+
Seven open-source document engines behind one API key: Docling, MarkItDown, WeasyPrint, veraPDF, Gotenberg, OCRmyPDF, EPUBCheck.
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
pip install pagespool
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
[Get an API key](https://pagespool.com/go/pypi-sdk?to=/app/api-keys) and pass it to the client:
|
|
19
|
+
|
|
20
|
+
```python
|
|
21
|
+
import os
|
|
22
|
+
|
|
23
|
+
from pagespool import AuthenticatedClient
|
|
24
|
+
from pagespool.api.account import get_me
|
|
25
|
+
|
|
26
|
+
client = AuthenticatedClient(
|
|
27
|
+
base_url="https://api.pagespool.com",
|
|
28
|
+
token=os.environ["PAGESPOOL_API_KEY"],
|
|
29
|
+
auth_header_name="X-API-Key",
|
|
30
|
+
prefix="",
|
|
31
|
+
)
|
|
32
|
+
print(get_me.sync(client=client))
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Every operation is a module with `sync`, `sync_detailed`, `asyncio` and `asyncio_detailed`; file fields take a `pagespool.types.File(payload=..., file_name=..., mime_type=...)`.
|
|
36
|
+
|
|
37
|
+
`ocrmypdf_submit` queues a job: poll `get_job` until its `status` is `succeeded` or `failed`, then fetch `ocrmypdf_get_result`.
|
|
38
|
+
|
|
39
|
+
`docling_convert_file_async` queues a job: poll `docling_status_poll` until its `status` is `succeeded` or `failed`, then fetch `docling_result`.
|
|
40
|
+
|
|
41
|
+
`docling_convert_source_async` queues a job: poll `docling_status_poll` until its `status` is `succeeded` or `failed`, then fetch `docling_result`.
|
|
42
|
+
|
|
43
|
+
## Operations
|
|
44
|
+
|
|
45
|
+
| Operation | Module | What it does |
|
|
46
|
+
|---|---|---|
|
|
47
|
+
| `GET /v1/me` | `pagespool.api.account.get_me` | Your plan, remaining requests, and remaining credits |
|
|
48
|
+
| `GET /v1/jobs/{job_id}` | `pagespool.api.jobs.get_job` | Get one queued job by ID |
|
|
49
|
+
| `GET /v1/jobs` | `pagespool.api.jobs.list_jobs` | List your queued jobs, newest first |
|
|
50
|
+
| `POST /v1/epubcheck/check` | `pagespool.api.epubcheck.epubcheck_check` | Check an EPUB file with EPUBCheck |
|
|
51
|
+
| `POST /v1/ocrmypdf/jobs` | `pagespool.api.ocrmypdf.ocrmypdf_submit` | OCR a scanned PDF or image, 2 credits per page |
|
|
52
|
+
| `GET /v1/ocrmypdf/jobs/{job_id}/result` | `pagespool.api.ocrmypdf.ocrmypdf_get_result` | Download the searchable PDF of an OCR job |
|
|
53
|
+
| `POST /v1/gotenberg/forms/chromium/convert/html` | `pagespool.api.gotenberg.gotenberg_chromium_convert_html` | Convert an HTML file to PDF with Chromium |
|
|
54
|
+
| `POST /v1/gotenberg/forms/chromium/convert/url` | `pagespool.api.gotenberg.gotenberg_chromium_convert_url` | Convert a web page to PDF with Chromium |
|
|
55
|
+
| `POST /v1/gotenberg/forms/chromium/convert/markdown` | `pagespool.api.gotenberg.gotenberg_chromium_convert_markdown` | Convert Markdown files to PDF with Chromium |
|
|
56
|
+
| `POST /v1/gotenberg/forms/chromium/screenshot/html` | `pagespool.api.gotenberg.gotenberg_chromium_screenshot_html` | Screenshot an HTML file with Chromium |
|
|
57
|
+
| `POST /v1/gotenberg/forms/chromium/screenshot/url` | `pagespool.api.gotenberg.gotenberg_chromium_screenshot_url` | Screenshot a web page with Chromium |
|
|
58
|
+
| `POST /v1/gotenberg/forms/chromium/screenshot/markdown` | `pagespool.api.gotenberg.gotenberg_chromium_screenshot_markdown` | Screenshot Markdown files with Chromium |
|
|
59
|
+
| `POST /v1/gotenberg/forms/libreoffice/convert` | `pagespool.api.gotenberg.gotenberg_libreoffice_convert` | Convert office documents to PDF with LibreOffice |
|
|
60
|
+
| `POST /v1/gotenberg/forms/pdf/pipe` | `pagespool.api.gotenberg.gotenberg_pdf_pipe` | Run a list of stages on PDFs |
|
|
61
|
+
| `POST /v1/gotenberg/forms/pdf/info` | `pagespool.api.gotenberg.gotenberg_pdf_info` | Read the page count and properties of PDFs |
|
|
62
|
+
| `POST /v1/gotenberg/forms/pdf/merge` | `pagespool.api.gotenberg.gotenberg_pdf_merge` | Merge PDFs |
|
|
63
|
+
| `POST /v1/gotenberg/forms/pdf/split` | `pagespool.api.gotenberg.gotenberg_pdf_split` | Split PDFs |
|
|
64
|
+
| `POST /v1/gotenberg/forms/pdf/select` | `pagespool.api.gotenberg.gotenberg_pdf_select` | Keep selected pages of PDFs |
|
|
65
|
+
| `POST /v1/gotenberg/forms/pdf/delete` | `pagespool.api.gotenberg.gotenberg_pdf_delete` | Delete pages of PDFs |
|
|
66
|
+
| `POST /v1/gotenberg/forms/pdf/insert` | `pagespool.api.gotenberg.gotenberg_pdf_insert` | Insert pages into PDFs |
|
|
67
|
+
| `POST /v1/gotenberg/forms/pdf/rotate` | `pagespool.api.gotenberg.gotenberg_pdf_rotate` | Rotate the pages of PDFs |
|
|
68
|
+
| `POST /v1/gotenberg/forms/pdf/compose` | `pagespool.api.gotenberg.gotenberg_pdf_compose` | Compose pages of PDFs on new pages |
|
|
69
|
+
| `POST /v1/gotenberg/forms/pdf/render` | `pagespool.api.gotenberg.gotenberg_pdf_render` | Render the pages of PDFs as images |
|
|
70
|
+
| `POST /v1/gotenberg/forms/pdf/stamp-text` | `pagespool.api.gotenberg.gotenberg_pdf_stamp_text` | Stamp text on PDFs |
|
|
71
|
+
| `POST /v1/gotenberg/forms/pdf/stamp-image` | `pagespool.api.gotenberg.gotenberg_pdf_stamp_image` | Stamp an image on PDFs |
|
|
72
|
+
| `POST /v1/gotenberg/forms/pdf/stamp-pdf` | `pagespool.api.gotenberg.gotenberg_pdf_stamp_pdf` | Stamp a PDF page on PDFs |
|
|
73
|
+
| `POST /v1/gotenberg/forms/pdf/metadata` | `pagespool.api.gotenberg.gotenberg_pdf_metadata` | Read the metadata of PDFs |
|
|
74
|
+
| `POST /v1/gotenberg/forms/pdf/set-metadata` | `pagespool.api.gotenberg.gotenberg_pdf_set_metadata` | Write the metadata of PDFs |
|
|
75
|
+
| `POST /v1/gotenberg/forms/pdf/bookmarks` | `pagespool.api.gotenberg.gotenberg_pdf_bookmarks` | Read the bookmarks of PDFs |
|
|
76
|
+
| `POST /v1/gotenberg/forms/pdf/set-bookmarks` | `pagespool.api.gotenberg.gotenberg_pdf_set_bookmarks` | Write the bookmarks of PDFs |
|
|
77
|
+
| `POST /v1/gotenberg/forms/pdf/attach` | `pagespool.api.gotenberg.gotenberg_pdf_attach` | Attach files to PDFs |
|
|
78
|
+
| `POST /v1/gotenberg/forms/pdf/attachments` | `pagespool.api.gotenberg.gotenberg_pdf_attachments` | List the attachments of PDFs |
|
|
79
|
+
| `POST /v1/gotenberg/forms/pdf/detach` | `pagespool.api.gotenberg.gotenberg_pdf_detach` | Remove an attachment from PDFs |
|
|
80
|
+
| `POST /v1/gotenberg/forms/pdf/extract-attachments` | `pagespool.api.gotenberg.gotenberg_pdf_extract_attachments` | Extract the attachments of PDFs |
|
|
81
|
+
| `POST /v1/gotenberg/forms/pdf/form` | `pagespool.api.gotenberg.gotenberg_pdf_form` | List the form fields of PDFs |
|
|
82
|
+
| `POST /v1/gotenberg/forms/pdf/set-form` | `pagespool.api.gotenberg.gotenberg_pdf_set_form` | Fill the form fields of PDFs |
|
|
83
|
+
| `POST /v1/gotenberg/forms/pdf/flatten-form` | `pagespool.api.gotenberg.gotenberg_pdf_flatten_form` | Flatten the form fields of PDFs |
|
|
84
|
+
| `POST /v1/gotenberg/forms/pdf/extract-text` | `pagespool.api.gotenberg.gotenberg_pdf_extract_text` | Extract the text of PDFs |
|
|
85
|
+
| `POST /v1/gotenberg/forms/pdf/redact` | `pagespool.api.gotenberg.gotenberg_pdf_redact` | Redact content from PDFs |
|
|
86
|
+
| `POST /v1/gotenberg/forms/pdf/optimize` | `pagespool.api.gotenberg.gotenberg_pdf_optimize` | Optimize PDFs |
|
|
87
|
+
| `POST /v1/gotenberg/forms/pdf/convert-colors` | `pagespool.api.gotenberg.gotenberg_pdf_convert_colors` | Convert the colors of PDFs |
|
|
88
|
+
| `POST /v1/gotenberg/forms/pdf/flatten-transparency` | `pagespool.api.gotenberg.gotenberg_pdf_flatten_transparency` | Flatten the transparency of PDFs |
|
|
89
|
+
| `POST /v1/gotenberg/forms/pdf/remediate` | `pagespool.api.gotenberg.gotenberg_pdf_remediate` | Make PDFs conform to PDF/A or PDF/UA |
|
|
90
|
+
| `POST /v1/gotenberg/forms/pdf/validate` | `pagespool.api.gotenberg.gotenberg_pdf_validate` | Validate PDFs against PDF/A or PDF/UA |
|
|
91
|
+
| `POST /v1/gotenberg/forms/pdf/autotag` | `pagespool.api.gotenberg.gotenberg_pdf_autotag` | Add structure tags to PDFs |
|
|
92
|
+
| `POST /v1/gotenberg/forms/pdf/encrypt` | `pagespool.api.gotenberg.gotenberg_pdf_encrypt` | Encrypt PDFs |
|
|
93
|
+
| `POST /v1/gotenberg/forms/pdf/decrypt` | `pagespool.api.gotenberg.gotenberg_pdf_decrypt` | Decrypt PDFs |
|
|
94
|
+
| `POST /v1/gotenberg/forms/pdf/sign` | `pagespool.api.gotenberg.gotenberg_pdf_sign` | Sign PDFs with a certificate |
|
|
95
|
+
| `POST /v1/gotenberg/forms/pdf/timestamp` | `pagespool.api.gotenberg.gotenberg_pdf_timestamp` | Timestamp PDFs |
|
|
96
|
+
| `GET /v1/gotenberg/health` | `pagespool.api.gotenberg.gotenberg_health` | Check that Gotenberg is up |
|
|
97
|
+
| `GET /v1/gotenberg/version` | `pagespool.api.gotenberg.gotenberg_version` | Show Gotenberg's version |
|
|
98
|
+
| `POST /v1/verapdf/api/validate/auto` | `pagespool.api.verapdf.verapdf_validate_auto` | Check a PDF against the PDF/A part it declares |
|
|
99
|
+
| `POST /v1/verapdf/api/validate/1a` | `pagespool.api.verapdf.verapdf_validate_1a` | Check a PDF against PDF/A-1a |
|
|
100
|
+
| `POST /v1/verapdf/api/validate/1b` | `pagespool.api.verapdf.verapdf_validate_1b` | Check a PDF against PDF/A-1b |
|
|
101
|
+
| `POST /v1/verapdf/api/validate/2a` | `pagespool.api.verapdf.verapdf_validate_2a` | Check a PDF against PDF/A-2a |
|
|
102
|
+
| `POST /v1/verapdf/api/validate/2b` | `pagespool.api.verapdf.verapdf_validate_2b` | Check a PDF against PDF/A-2b |
|
|
103
|
+
| `POST /v1/verapdf/api/validate/2u` | `pagespool.api.verapdf.verapdf_validate_2u` | Check a PDF against PDF/A-2u |
|
|
104
|
+
| `POST /v1/verapdf/api/validate/3a` | `pagespool.api.verapdf.verapdf_validate_3a` | Check a PDF against PDF/A-3a |
|
|
105
|
+
| `POST /v1/verapdf/api/validate/3b` | `pagespool.api.verapdf.verapdf_validate_3b` | Check a PDF against PDF/A-3b |
|
|
106
|
+
| `POST /v1/verapdf/api/validate/3u` | `pagespool.api.verapdf.verapdf_validate_3u` | Check a PDF against PDF/A-3u |
|
|
107
|
+
| `POST /v1/verapdf/api/validate/4` | `pagespool.api.verapdf.verapdf_validate_4` | Check a PDF against PDF/A-4 |
|
|
108
|
+
| `POST /v1/verapdf/api/validate/4e` | `pagespool.api.verapdf.verapdf_validate_4e` | Check a PDF against PDF/A-4e |
|
|
109
|
+
| `POST /v1/verapdf/api/validate/4f` | `pagespool.api.verapdf.verapdf_validate_4f` | Check a PDF against PDF/A-4f |
|
|
110
|
+
| `POST /v1/verapdf/api/validate/ua1` | `pagespool.api.verapdf.verapdf_validate_ua1` | Check a PDF against PDF/UA-1 |
|
|
111
|
+
| `POST /v1/verapdf/api/validate/ua2` | `pagespool.api.verapdf.verapdf_validate_ua2` | Check a PDF against PDF/UA-2 |
|
|
112
|
+
| `POST /v1/verapdf/api/validate/wt1a` | `pagespool.api.verapdf.verapdf_validate_wt1a` | Check a PDF against WTPDF 1.0 Accessibility |
|
|
113
|
+
| `POST /v1/verapdf/api/validate/wt1r` | `pagespool.api.verapdf.verapdf_validate_wt1r` | Check a PDF against WTPDF 1.0 Reuse |
|
|
114
|
+
| `GET /v1/verapdf/api/info` | `pagespool.api.verapdf.verapdf_info` | Get the veraPDF server's environment |
|
|
115
|
+
| `GET /v1/verapdf/api/profiles` | `pagespool.api.verapdf.verapdf_list_profiles` | List veraPDF's validation profiles |
|
|
116
|
+
| `GET /v1/verapdf/api/profiles/{profile_id}` | `pagespool.api.verapdf.verapdf_get_profile` | Get one veraPDF validation profile |
|
|
117
|
+
| `POST /v1/weasyprint/render` | `pagespool.api.weasyprint.weasyprint_render` | Render an HTML document to a PDF |
|
|
118
|
+
| `POST /v1/markitdown/convert` | `pagespool.api.markitdown.markitdown_convert` | Convert a document to Markdown with MarkItDown |
|
|
119
|
+
| `POST /v1/docling/v1/convert/file` | `pagespool.api.docling.docling_convert_file` | Convert an uploaded document, waiting up to 50 s (1 credit per PDF page, 10 per other file) |
|
|
120
|
+
| `POST /v1/docling/v1/convert/file/async` | `pagespool.api.docling.docling_convert_file_async` | Queue an uploaded document for conversion (1 credit per PDF page, 10 per other file) |
|
|
121
|
+
| `POST /v1/docling/v1/convert/source` | `pagespool.api.docling.docling_convert_source` | Convert a document from a URL or base64, waiting up to 50 s (1 credit per PDF page, 10 per other file) |
|
|
122
|
+
| `POST /v1/docling/v1/convert/source/async` | `pagespool.api.docling.docling_convert_source_async` | Queue a document from a URL or base64 for conversion (1 credit per PDF page, 10 per other file) |
|
|
123
|
+
| `GET /v1/docling/v1/status/poll/{task_id}` | `pagespool.api.docling.docling_status_poll` | Check a conversion |
|
|
124
|
+
| `GET /v1/docling/v1/result/{task_id}` | `pagespool.api.docling.docling_result` | Download a conversion's result |
|
|
125
|
+
|
|
126
|
+
Generated with openapi-python-client from [`openapi.sdk.json`](../openapi.sdk.json). API reference: https://pagespool.com/docs · Support: https://pagespool.com/support
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# pagespool — Python SDK
|
|
2
|
+
|
|
3
|
+
Seven open-source document engines behind one API key: Docling, MarkItDown, WeasyPrint, veraPDF, Gotenberg, OCRmyPDF, EPUBCheck.
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
pip install pagespool
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
[Get an API key](https://pagespool.com/go/pypi-sdk?to=/app/api-keys) and pass it to the client:
|
|
10
|
+
|
|
11
|
+
```python
|
|
12
|
+
import os
|
|
13
|
+
|
|
14
|
+
from pagespool import AuthenticatedClient
|
|
15
|
+
from pagespool.api.account import get_me
|
|
16
|
+
|
|
17
|
+
client = AuthenticatedClient(
|
|
18
|
+
base_url="https://api.pagespool.com",
|
|
19
|
+
token=os.environ["PAGESPOOL_API_KEY"],
|
|
20
|
+
auth_header_name="X-API-Key",
|
|
21
|
+
prefix="",
|
|
22
|
+
)
|
|
23
|
+
print(get_me.sync(client=client))
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Every operation is a module with `sync`, `sync_detailed`, `asyncio` and `asyncio_detailed`; file fields take a `pagespool.types.File(payload=..., file_name=..., mime_type=...)`.
|
|
27
|
+
|
|
28
|
+
`ocrmypdf_submit` queues a job: poll `get_job` until its `status` is `succeeded` or `failed`, then fetch `ocrmypdf_get_result`.
|
|
29
|
+
|
|
30
|
+
`docling_convert_file_async` queues a job: poll `docling_status_poll` until its `status` is `succeeded` or `failed`, then fetch `docling_result`.
|
|
31
|
+
|
|
32
|
+
`docling_convert_source_async` queues a job: poll `docling_status_poll` until its `status` is `succeeded` or `failed`, then fetch `docling_result`.
|
|
33
|
+
|
|
34
|
+
## Operations
|
|
35
|
+
|
|
36
|
+
| Operation | Module | What it does |
|
|
37
|
+
|---|---|---|
|
|
38
|
+
| `GET /v1/me` | `pagespool.api.account.get_me` | Your plan, remaining requests, and remaining credits |
|
|
39
|
+
| `GET /v1/jobs/{job_id}` | `pagespool.api.jobs.get_job` | Get one queued job by ID |
|
|
40
|
+
| `GET /v1/jobs` | `pagespool.api.jobs.list_jobs` | List your queued jobs, newest first |
|
|
41
|
+
| `POST /v1/epubcheck/check` | `pagespool.api.epubcheck.epubcheck_check` | Check an EPUB file with EPUBCheck |
|
|
42
|
+
| `POST /v1/ocrmypdf/jobs` | `pagespool.api.ocrmypdf.ocrmypdf_submit` | OCR a scanned PDF or image, 2 credits per page |
|
|
43
|
+
| `GET /v1/ocrmypdf/jobs/{job_id}/result` | `pagespool.api.ocrmypdf.ocrmypdf_get_result` | Download the searchable PDF of an OCR job |
|
|
44
|
+
| `POST /v1/gotenberg/forms/chromium/convert/html` | `pagespool.api.gotenberg.gotenberg_chromium_convert_html` | Convert an HTML file to PDF with Chromium |
|
|
45
|
+
| `POST /v1/gotenberg/forms/chromium/convert/url` | `pagespool.api.gotenberg.gotenberg_chromium_convert_url` | Convert a web page to PDF with Chromium |
|
|
46
|
+
| `POST /v1/gotenberg/forms/chromium/convert/markdown` | `pagespool.api.gotenberg.gotenberg_chromium_convert_markdown` | Convert Markdown files to PDF with Chromium |
|
|
47
|
+
| `POST /v1/gotenberg/forms/chromium/screenshot/html` | `pagespool.api.gotenberg.gotenberg_chromium_screenshot_html` | Screenshot an HTML file with Chromium |
|
|
48
|
+
| `POST /v1/gotenberg/forms/chromium/screenshot/url` | `pagespool.api.gotenberg.gotenberg_chromium_screenshot_url` | Screenshot a web page with Chromium |
|
|
49
|
+
| `POST /v1/gotenberg/forms/chromium/screenshot/markdown` | `pagespool.api.gotenberg.gotenberg_chromium_screenshot_markdown` | Screenshot Markdown files with Chromium |
|
|
50
|
+
| `POST /v1/gotenberg/forms/libreoffice/convert` | `pagespool.api.gotenberg.gotenberg_libreoffice_convert` | Convert office documents to PDF with LibreOffice |
|
|
51
|
+
| `POST /v1/gotenberg/forms/pdf/pipe` | `pagespool.api.gotenberg.gotenberg_pdf_pipe` | Run a list of stages on PDFs |
|
|
52
|
+
| `POST /v1/gotenberg/forms/pdf/info` | `pagespool.api.gotenberg.gotenberg_pdf_info` | Read the page count and properties of PDFs |
|
|
53
|
+
| `POST /v1/gotenberg/forms/pdf/merge` | `pagespool.api.gotenberg.gotenberg_pdf_merge` | Merge PDFs |
|
|
54
|
+
| `POST /v1/gotenberg/forms/pdf/split` | `pagespool.api.gotenberg.gotenberg_pdf_split` | Split PDFs |
|
|
55
|
+
| `POST /v1/gotenberg/forms/pdf/select` | `pagespool.api.gotenberg.gotenberg_pdf_select` | Keep selected pages of PDFs |
|
|
56
|
+
| `POST /v1/gotenberg/forms/pdf/delete` | `pagespool.api.gotenberg.gotenberg_pdf_delete` | Delete pages of PDFs |
|
|
57
|
+
| `POST /v1/gotenberg/forms/pdf/insert` | `pagespool.api.gotenberg.gotenberg_pdf_insert` | Insert pages into PDFs |
|
|
58
|
+
| `POST /v1/gotenberg/forms/pdf/rotate` | `pagespool.api.gotenberg.gotenberg_pdf_rotate` | Rotate the pages of PDFs |
|
|
59
|
+
| `POST /v1/gotenberg/forms/pdf/compose` | `pagespool.api.gotenberg.gotenberg_pdf_compose` | Compose pages of PDFs on new pages |
|
|
60
|
+
| `POST /v1/gotenberg/forms/pdf/render` | `pagespool.api.gotenberg.gotenberg_pdf_render` | Render the pages of PDFs as images |
|
|
61
|
+
| `POST /v1/gotenberg/forms/pdf/stamp-text` | `pagespool.api.gotenberg.gotenberg_pdf_stamp_text` | Stamp text on PDFs |
|
|
62
|
+
| `POST /v1/gotenberg/forms/pdf/stamp-image` | `pagespool.api.gotenberg.gotenberg_pdf_stamp_image` | Stamp an image on PDFs |
|
|
63
|
+
| `POST /v1/gotenberg/forms/pdf/stamp-pdf` | `pagespool.api.gotenberg.gotenberg_pdf_stamp_pdf` | Stamp a PDF page on PDFs |
|
|
64
|
+
| `POST /v1/gotenberg/forms/pdf/metadata` | `pagespool.api.gotenberg.gotenberg_pdf_metadata` | Read the metadata of PDFs |
|
|
65
|
+
| `POST /v1/gotenberg/forms/pdf/set-metadata` | `pagespool.api.gotenberg.gotenberg_pdf_set_metadata` | Write the metadata of PDFs |
|
|
66
|
+
| `POST /v1/gotenberg/forms/pdf/bookmarks` | `pagespool.api.gotenberg.gotenberg_pdf_bookmarks` | Read the bookmarks of PDFs |
|
|
67
|
+
| `POST /v1/gotenberg/forms/pdf/set-bookmarks` | `pagespool.api.gotenberg.gotenberg_pdf_set_bookmarks` | Write the bookmarks of PDFs |
|
|
68
|
+
| `POST /v1/gotenberg/forms/pdf/attach` | `pagespool.api.gotenberg.gotenberg_pdf_attach` | Attach files to PDFs |
|
|
69
|
+
| `POST /v1/gotenberg/forms/pdf/attachments` | `pagespool.api.gotenberg.gotenberg_pdf_attachments` | List the attachments of PDFs |
|
|
70
|
+
| `POST /v1/gotenberg/forms/pdf/detach` | `pagespool.api.gotenberg.gotenberg_pdf_detach` | Remove an attachment from PDFs |
|
|
71
|
+
| `POST /v1/gotenberg/forms/pdf/extract-attachments` | `pagespool.api.gotenberg.gotenberg_pdf_extract_attachments` | Extract the attachments of PDFs |
|
|
72
|
+
| `POST /v1/gotenberg/forms/pdf/form` | `pagespool.api.gotenberg.gotenberg_pdf_form` | List the form fields of PDFs |
|
|
73
|
+
| `POST /v1/gotenberg/forms/pdf/set-form` | `pagespool.api.gotenberg.gotenberg_pdf_set_form` | Fill the form fields of PDFs |
|
|
74
|
+
| `POST /v1/gotenberg/forms/pdf/flatten-form` | `pagespool.api.gotenberg.gotenberg_pdf_flatten_form` | Flatten the form fields of PDFs |
|
|
75
|
+
| `POST /v1/gotenberg/forms/pdf/extract-text` | `pagespool.api.gotenberg.gotenberg_pdf_extract_text` | Extract the text of PDFs |
|
|
76
|
+
| `POST /v1/gotenberg/forms/pdf/redact` | `pagespool.api.gotenberg.gotenberg_pdf_redact` | Redact content from PDFs |
|
|
77
|
+
| `POST /v1/gotenberg/forms/pdf/optimize` | `pagespool.api.gotenberg.gotenberg_pdf_optimize` | Optimize PDFs |
|
|
78
|
+
| `POST /v1/gotenberg/forms/pdf/convert-colors` | `pagespool.api.gotenberg.gotenberg_pdf_convert_colors` | Convert the colors of PDFs |
|
|
79
|
+
| `POST /v1/gotenberg/forms/pdf/flatten-transparency` | `pagespool.api.gotenberg.gotenberg_pdf_flatten_transparency` | Flatten the transparency of PDFs |
|
|
80
|
+
| `POST /v1/gotenberg/forms/pdf/remediate` | `pagespool.api.gotenberg.gotenberg_pdf_remediate` | Make PDFs conform to PDF/A or PDF/UA |
|
|
81
|
+
| `POST /v1/gotenberg/forms/pdf/validate` | `pagespool.api.gotenberg.gotenberg_pdf_validate` | Validate PDFs against PDF/A or PDF/UA |
|
|
82
|
+
| `POST /v1/gotenberg/forms/pdf/autotag` | `pagespool.api.gotenberg.gotenberg_pdf_autotag` | Add structure tags to PDFs |
|
|
83
|
+
| `POST /v1/gotenberg/forms/pdf/encrypt` | `pagespool.api.gotenberg.gotenberg_pdf_encrypt` | Encrypt PDFs |
|
|
84
|
+
| `POST /v1/gotenberg/forms/pdf/decrypt` | `pagespool.api.gotenberg.gotenberg_pdf_decrypt` | Decrypt PDFs |
|
|
85
|
+
| `POST /v1/gotenberg/forms/pdf/sign` | `pagespool.api.gotenberg.gotenberg_pdf_sign` | Sign PDFs with a certificate |
|
|
86
|
+
| `POST /v1/gotenberg/forms/pdf/timestamp` | `pagespool.api.gotenberg.gotenberg_pdf_timestamp` | Timestamp PDFs |
|
|
87
|
+
| `GET /v1/gotenberg/health` | `pagespool.api.gotenberg.gotenberg_health` | Check that Gotenberg is up |
|
|
88
|
+
| `GET /v1/gotenberg/version` | `pagespool.api.gotenberg.gotenberg_version` | Show Gotenberg's version |
|
|
89
|
+
| `POST /v1/verapdf/api/validate/auto` | `pagespool.api.verapdf.verapdf_validate_auto` | Check a PDF against the PDF/A part it declares |
|
|
90
|
+
| `POST /v1/verapdf/api/validate/1a` | `pagespool.api.verapdf.verapdf_validate_1a` | Check a PDF against PDF/A-1a |
|
|
91
|
+
| `POST /v1/verapdf/api/validate/1b` | `pagespool.api.verapdf.verapdf_validate_1b` | Check a PDF against PDF/A-1b |
|
|
92
|
+
| `POST /v1/verapdf/api/validate/2a` | `pagespool.api.verapdf.verapdf_validate_2a` | Check a PDF against PDF/A-2a |
|
|
93
|
+
| `POST /v1/verapdf/api/validate/2b` | `pagespool.api.verapdf.verapdf_validate_2b` | Check a PDF against PDF/A-2b |
|
|
94
|
+
| `POST /v1/verapdf/api/validate/2u` | `pagespool.api.verapdf.verapdf_validate_2u` | Check a PDF against PDF/A-2u |
|
|
95
|
+
| `POST /v1/verapdf/api/validate/3a` | `pagespool.api.verapdf.verapdf_validate_3a` | Check a PDF against PDF/A-3a |
|
|
96
|
+
| `POST /v1/verapdf/api/validate/3b` | `pagespool.api.verapdf.verapdf_validate_3b` | Check a PDF against PDF/A-3b |
|
|
97
|
+
| `POST /v1/verapdf/api/validate/3u` | `pagespool.api.verapdf.verapdf_validate_3u` | Check a PDF against PDF/A-3u |
|
|
98
|
+
| `POST /v1/verapdf/api/validate/4` | `pagespool.api.verapdf.verapdf_validate_4` | Check a PDF against PDF/A-4 |
|
|
99
|
+
| `POST /v1/verapdf/api/validate/4e` | `pagespool.api.verapdf.verapdf_validate_4e` | Check a PDF against PDF/A-4e |
|
|
100
|
+
| `POST /v1/verapdf/api/validate/4f` | `pagespool.api.verapdf.verapdf_validate_4f` | Check a PDF against PDF/A-4f |
|
|
101
|
+
| `POST /v1/verapdf/api/validate/ua1` | `pagespool.api.verapdf.verapdf_validate_ua1` | Check a PDF against PDF/UA-1 |
|
|
102
|
+
| `POST /v1/verapdf/api/validate/ua2` | `pagespool.api.verapdf.verapdf_validate_ua2` | Check a PDF against PDF/UA-2 |
|
|
103
|
+
| `POST /v1/verapdf/api/validate/wt1a` | `pagespool.api.verapdf.verapdf_validate_wt1a` | Check a PDF against WTPDF 1.0 Accessibility |
|
|
104
|
+
| `POST /v1/verapdf/api/validate/wt1r` | `pagespool.api.verapdf.verapdf_validate_wt1r` | Check a PDF against WTPDF 1.0 Reuse |
|
|
105
|
+
| `GET /v1/verapdf/api/info` | `pagespool.api.verapdf.verapdf_info` | Get the veraPDF server's environment |
|
|
106
|
+
| `GET /v1/verapdf/api/profiles` | `pagespool.api.verapdf.verapdf_list_profiles` | List veraPDF's validation profiles |
|
|
107
|
+
| `GET /v1/verapdf/api/profiles/{profile_id}` | `pagespool.api.verapdf.verapdf_get_profile` | Get one veraPDF validation profile |
|
|
108
|
+
| `POST /v1/weasyprint/render` | `pagespool.api.weasyprint.weasyprint_render` | Render an HTML document to a PDF |
|
|
109
|
+
| `POST /v1/markitdown/convert` | `pagespool.api.markitdown.markitdown_convert` | Convert a document to Markdown with MarkItDown |
|
|
110
|
+
| `POST /v1/docling/v1/convert/file` | `pagespool.api.docling.docling_convert_file` | Convert an uploaded document, waiting up to 50 s (1 credit per PDF page, 10 per other file) |
|
|
111
|
+
| `POST /v1/docling/v1/convert/file/async` | `pagespool.api.docling.docling_convert_file_async` | Queue an uploaded document for conversion (1 credit per PDF page, 10 per other file) |
|
|
112
|
+
| `POST /v1/docling/v1/convert/source` | `pagespool.api.docling.docling_convert_source` | Convert a document from a URL or base64, waiting up to 50 s (1 credit per PDF page, 10 per other file) |
|
|
113
|
+
| `POST /v1/docling/v1/convert/source/async` | `pagespool.api.docling.docling_convert_source_async` | Queue a document from a URL or base64 for conversion (1 credit per PDF page, 10 per other file) |
|
|
114
|
+
| `GET /v1/docling/v1/status/poll/{task_id}` | `pagespool.api.docling.docling_status_poll` | Check a conversion |
|
|
115
|
+
| `GET /v1/docling/v1/result/{task_id}` | `pagespool.api.docling.docling_result` | Download a conversion's result |
|
|
116
|
+
|
|
117
|
+
Generated with openapi-python-client from [`openapi.sdk.json`](../openapi.sdk.json). API reference: https://pagespool.com/docs · Support: https://pagespool.com/support
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""Contains methods for accessing the API"""
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""Contains endpoint functions for accessing the API"""
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
from http import HTTPStatus
|
|
2
|
+
from typing import Any
|
|
3
|
+
|
|
4
|
+
import httpx2
|
|
5
|
+
|
|
6
|
+
from ... import errors
|
|
7
|
+
from ...client import AuthenticatedClient, Client
|
|
8
|
+
from ...models.me_response import MeResponse
|
|
9
|
+
from ...types import Response
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
def _get_kwargs() -> dict[str, Any]:
|
|
13
|
+
|
|
14
|
+
_kwargs: dict[str, Any] = {
|
|
15
|
+
"method": "get",
|
|
16
|
+
"url": "/v1/me",
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
return _kwargs
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
def _parse_response(*, client: AuthenticatedClient | Client, response: httpx2.Response) -> MeResponse | None:
|
|
23
|
+
if response.status_code == 200:
|
|
24
|
+
response_200 = MeResponse.from_dict(response.json())
|
|
25
|
+
|
|
26
|
+
return response_200
|
|
27
|
+
|
|
28
|
+
if client.raise_on_unexpected_status:
|
|
29
|
+
raise errors.UnexpectedStatus(response.status_code, response.content)
|
|
30
|
+
else:
|
|
31
|
+
return None
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
def _build_response(*, client: AuthenticatedClient | Client, response: httpx2.Response) -> Response[MeResponse]:
|
|
35
|
+
return Response(
|
|
36
|
+
status_code=HTTPStatus(response.status_code),
|
|
37
|
+
content=response.content,
|
|
38
|
+
headers=response.headers,
|
|
39
|
+
parsed=_parse_response(client=client, response=response),
|
|
40
|
+
)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
def sync_detailed(
|
|
44
|
+
*,
|
|
45
|
+
client: AuthenticatedClient,
|
|
46
|
+
) -> Response[MeResponse]:
|
|
47
|
+
"""Your plan, remaining requests, and remaining credits
|
|
48
|
+
|
|
49
|
+
Check where you stand before a call fails.
|
|
50
|
+
|
|
51
|
+
Returns the plan this request runs on and whether your key was recognized.
|
|
52
|
+
Without an `X-API-Key`, the call runs anonymously at the rate limit for
|
|
53
|
+
calls without a key. It also returns the requests left in the current window
|
|
54
|
+
and the features your plan includes. On plans priced in credits, it returns
|
|
55
|
+
the credits left in the current billing period.
|
|
56
|
+
|
|
57
|
+
This call does not count against your rate limit, so the numbers it reports
|
|
58
|
+
are the numbers you have.
|
|
59
|
+
|
|
60
|
+
**Credits:** free. This endpoint is not metered.
|
|
61
|
+
|
|
62
|
+
Raises:
|
|
63
|
+
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
|
|
64
|
+
httpx2.TimeoutException: If the request takes longer than Client.timeout.
|
|
65
|
+
|
|
66
|
+
Returns:
|
|
67
|
+
Response[MeResponse]
|
|
68
|
+
"""
|
|
69
|
+
|
|
70
|
+
kwargs = _get_kwargs()
|
|
71
|
+
|
|
72
|
+
response = client.get_httpx_client().request(
|
|
73
|
+
**kwargs,
|
|
74
|
+
)
|
|
75
|
+
|
|
76
|
+
return _build_response(client=client, response=response)
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
def sync(
|
|
80
|
+
*,
|
|
81
|
+
client: AuthenticatedClient,
|
|
82
|
+
) -> MeResponse | None:
|
|
83
|
+
"""Your plan, remaining requests, and remaining credits
|
|
84
|
+
|
|
85
|
+
Check where you stand before a call fails.
|
|
86
|
+
|
|
87
|
+
Returns the plan this request runs on and whether your key was recognized.
|
|
88
|
+
Without an `X-API-Key`, the call runs anonymously at the rate limit for
|
|
89
|
+
calls without a key. It also returns the requests left in the current window
|
|
90
|
+
and the features your plan includes. On plans priced in credits, it returns
|
|
91
|
+
the credits left in the current billing period.
|
|
92
|
+
|
|
93
|
+
This call does not count against your rate limit, so the numbers it reports
|
|
94
|
+
are the numbers you have.
|
|
95
|
+
|
|
96
|
+
**Credits:** free. This endpoint is not metered.
|
|
97
|
+
|
|
98
|
+
Raises:
|
|
99
|
+
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
|
|
100
|
+
httpx2.TimeoutException: If the request takes longer than Client.timeout.
|
|
101
|
+
|
|
102
|
+
Returns:
|
|
103
|
+
MeResponse
|
|
104
|
+
"""
|
|
105
|
+
|
|
106
|
+
return sync_detailed(
|
|
107
|
+
client=client,
|
|
108
|
+
).parsed
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
async def asyncio_detailed(
|
|
112
|
+
*,
|
|
113
|
+
client: AuthenticatedClient,
|
|
114
|
+
) -> Response[MeResponse]:
|
|
115
|
+
"""Your plan, remaining requests, and remaining credits
|
|
116
|
+
|
|
117
|
+
Check where you stand before a call fails.
|
|
118
|
+
|
|
119
|
+
Returns the plan this request runs on and whether your key was recognized.
|
|
120
|
+
Without an `X-API-Key`, the call runs anonymously at the rate limit for
|
|
121
|
+
calls without a key. It also returns the requests left in the current window
|
|
122
|
+
and the features your plan includes. On plans priced in credits, it returns
|
|
123
|
+
the credits left in the current billing period.
|
|
124
|
+
|
|
125
|
+
This call does not count against your rate limit, so the numbers it reports
|
|
126
|
+
are the numbers you have.
|
|
127
|
+
|
|
128
|
+
**Credits:** free. This endpoint is not metered.
|
|
129
|
+
|
|
130
|
+
Raises:
|
|
131
|
+
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
|
|
132
|
+
httpx2.TimeoutException: If the request takes longer than Client.timeout.
|
|
133
|
+
|
|
134
|
+
Returns:
|
|
135
|
+
Response[MeResponse]
|
|
136
|
+
"""
|
|
137
|
+
|
|
138
|
+
kwargs = _get_kwargs()
|
|
139
|
+
|
|
140
|
+
response = await client.get_async_httpx_client().request(**kwargs)
|
|
141
|
+
|
|
142
|
+
return _build_response(client=client, response=response)
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
async def asyncio(
|
|
146
|
+
*,
|
|
147
|
+
client: AuthenticatedClient,
|
|
148
|
+
) -> MeResponse | None:
|
|
149
|
+
"""Your plan, remaining requests, and remaining credits
|
|
150
|
+
|
|
151
|
+
Check where you stand before a call fails.
|
|
152
|
+
|
|
153
|
+
Returns the plan this request runs on and whether your key was recognized.
|
|
154
|
+
Without an `X-API-Key`, the call runs anonymously at the rate limit for
|
|
155
|
+
calls without a key. It also returns the requests left in the current window
|
|
156
|
+
and the features your plan includes. On plans priced in credits, it returns
|
|
157
|
+
the credits left in the current billing period.
|
|
158
|
+
|
|
159
|
+
This call does not count against your rate limit, so the numbers it reports
|
|
160
|
+
are the numbers you have.
|
|
161
|
+
|
|
162
|
+
**Credits:** free. This endpoint is not metered.
|
|
163
|
+
|
|
164
|
+
Raises:
|
|
165
|
+
errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
|
|
166
|
+
httpx2.TimeoutException: If the request takes longer than Client.timeout.
|
|
167
|
+
|
|
168
|
+
Returns:
|
|
169
|
+
MeResponse
|
|
170
|
+
"""
|
|
171
|
+
|
|
172
|
+
return (
|
|
173
|
+
await asyncio_detailed(
|
|
174
|
+
client=client,
|
|
175
|
+
)
|
|
176
|
+
).parsed
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"""Contains endpoint functions for accessing the API"""
|