cloudmersive_convert_api_client.EditPdfApi

All URIs are relative to https://api.cloudmersive.com

Method	HTTP request	Description
edit_pdf_add_annotations	POST /convert/edit/pdf/annotations/add-item	Add one or more PDF annotations, comments in the PDF document
edit_pdf_convert_to_pdf_a	POST /convert/edit/pdf/optimize/pdf-a	Convert a PDF file to PDF/A
edit_pdf_decrypt	POST /convert/edit/pdf/decrypt	Decrypt and password-protect a PDF
edit_pdf_delete_pages	POST /convert/edit/pdf/pages/delete	Remove, delete pages from a PDF document
edit_pdf_delete_pages_batch_job	POST /convert/edit/pdf/pages/delete/batch-job	Remove, delete pages from a PDF document as Batch Job
edit_pdf_encrypt	POST /convert/edit/pdf/encrypt	Encrypt and password-protect a PDF
edit_pdf_get_annotations	POST /convert/edit/pdf/annotations/list	Get PDF annotations, including comments in the document
edit_pdf_get_async_job_status	GET /convert/edit/pdf/batch-job/status	Get the status and result of a PDF Batch Job
edit_pdf_get_form_fields	POST /convert/edit/pdf/form/get-fields	Gets PDF Form fields and values
edit_pdf_get_metadata	POST /convert/edit/pdf/get-metadata	Get PDF document metadata
edit_pdf_get_pdf_text_by_pages	POST /convert/edit/pdf/pages/get-text	Get text in a PDF document by page
edit_pdf_insert_pages	POST /convert/edit/pdf/pages/insert	Insert, copy pages from one PDF document into another
edit_pdf_insert_pages_batch_job	POST /convert/edit/pdf/pages/insert/batch-job	Insert, copy pages from one PDF document into another as a batch job
edit_pdf_linearize	POST /convert/edit/pdf/optimize/linearize	Linearize and optimize a PDF for streaming download
edit_pdf_rasterize	POST /convert/edit/pdf/rasterize	Rasterize a PDF to an image-based PDF
edit_pdf_rasterize_batch_job	POST /convert/edit/pdf/rasterize/batch-job	Rasterize a PDF to an image-based PDF as Batch Job
edit_pdf_reduce_file_size	POST /convert/edit/pdf/optimize/reduce-file-size	Reduce the file size and optimize a PDF
edit_pdf_remove_all_annotations	POST /convert/edit/pdf/annotations/remove-all	Remove all PDF annotations, including comments in the document
edit_pdf_remove_annotation_item	POST /convert/edit/pdf/annotations/remove-item	Remove a specific PDF annotation, comment in the document
edit_pdf_resize	POST /convert/edit/pdf/resize	Change PDF Document's Paper Size
edit_pdf_rotate_all_pages	POST /convert/edit/pdf/pages/rotate/all	Rotate all pages in a PDF document
edit_pdf_rotate_page_range	POST /convert/edit/pdf/pages/rotate/page-range	Rotate a range, subset of pages in a PDF document
edit_pdf_set_form_fields	POST /convert/edit/pdf/form/set-fields	Sets ands fills PDF Form field values
edit_pdf_set_metadata	POST /convert/edit/pdf/set-metadata	Sets PDF document metadata
edit_pdf_set_permissions	POST /convert/edit/pdf/encrypt/set-permissions	Encrypt, password-protect and set restricted permissions on a PDF
edit_pdf_watermark_text	POST /convert/edit/pdf/watermark/text	Add a text watermark to a PDF

edit_pdf_add_annotations

str edit_pdf_add_annotations(request)

Add one or more PDF annotations, comments in the PDF document

Adds one or more annotations, comments to a PDF document.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
request = cloudmersive_convert_api_client.AddPdfAnnotationRequest() # AddPdfAnnotationRequest | 

try:
    # Add one or more PDF annotations, comments in the PDF document
    api_response = api_instance.edit_pdf_add_annotations(request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_add_annotations: %s\n" % e)

Parameters

Name	Type	Description	Notes
request	AddPdfAnnotationRequest

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_convert_to_pdf_a

str edit_pdf_convert_to_pdf_a(input_file, conformance_level=conformance_level)

Convert a PDF file to PDF/A

Converts the input PDF file to a PDF/A-1b or PDF/A-2b standardized PDF.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
conformance_level = 'conformance_level_example' # str | Optional: Select the conformance level for PDF/A - specify '1b' for PDF/A-1b or specify '2b' for PDF/A-2b; default is PDF/A-1b (optional)

try:
    # Convert a PDF file to PDF/A
    api_response = api_instance.edit_pdf_convert_to_pdf_a(input_file, conformance_level=conformance_level)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_convert_to_pdf_a: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
conformance_level	str	Optional: Select the conformance level for PDF/A - specify '1b' for PDF/A-1b or specify '2b' for PDF/A-2b; default is PDF/A-1b	[optional]

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_decrypt

str edit_pdf_decrypt(password, input_file)

Decrypt and password-protect a PDF

Decrypt a PDF document with a password. Decrypted PDF will no longer require a password to open.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
password = 'password_example' # str | Valid password for the PDF file
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.

try:
    # Decrypt and password-protect a PDF
    api_response = api_instance.edit_pdf_decrypt(password, input_file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_decrypt: %s\n" % e)

Parameters

Name	Type	Description	Notes
password	str	Valid password for the PDF file
input_file	file	Input file to perform the operation on.

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_delete_pages

str edit_pdf_delete_pages(input_file, page_start, page_end)

Remove, delete pages from a PDF document

Remove one or more pages from a PDF document

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
page_start = 56 # int | Page number (1 based) to start deleting pages from (inclusive).
page_end = 56 # int | Page number (1 based) to stop deleting pages from (inclusive).

try:
    # Remove, delete pages from a PDF document
    api_response = api_instance.edit_pdf_delete_pages(input_file, page_start, page_end)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_delete_pages: %s\n" % e)

Parameters

Name	Type	Description
input_file	file	Input file to perform the operation on.
page_start	int	Page number (1 based) to start deleting pages from (inclusive).
page_end	int	Page number (1 based) to stop deleting pages from (inclusive).

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_delete_pages_batch_job

EditPdfBatchJobCreateResult edit_pdf_delete_pages_batch_job(input_file, page_start, page_end)

Remove, delete pages from a PDF document as Batch Job

Remove one or more pages from a PDF document. Runs as a batch job async and returns a batch job ID that you can check the status of to get the result. Requires Cloudmersive Private Cloud or Managed Instance.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
page_start = 56 # int | Page number (1 based) to start deleting pages from (inclusive).
page_end = 56 # int | Page number (1 based) to stop deleting pages from (inclusive).

try:
    # Remove, delete pages from a PDF document as Batch Job
    api_response = api_instance.edit_pdf_delete_pages_batch_job(input_file, page_start, page_end)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_delete_pages_batch_job: %s\n" % e)

Parameters

Name	Type	Description
input_file	file	Input file to perform the operation on.
page_start	int	Page number (1 based) to start deleting pages from (inclusive).
page_end	int	Page number (1 based) to stop deleting pages from (inclusive).

Return type

EditPdfBatchJobCreateResult

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_encrypt

str edit_pdf_encrypt(input_file, user_password=user_password, owner_password=owner_password, encryption_key_length=encryption_key_length)

Encrypt and password-protect a PDF

Encrypt a PDF document with a password. Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF. Set the password fields null to omit the given password.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
user_password = 'user_password_example' # str | Password of a user (reader) of the PDF file (optional)
owner_password = 'owner_password_example' # str | Password of a owner (creator/editor) of the PDF file (optional)
encryption_key_length = 'encryption_key_length_example' # str | Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption).  Default is 256. (optional)

try:
    # Encrypt and password-protect a PDF
    api_response = api_instance.edit_pdf_encrypt(input_file, user_password=user_password, owner_password=owner_password, encryption_key_length=encryption_key_length)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_encrypt: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
user_password	str	Password of a user (reader) of the PDF file	[optional]
owner_password	str	Password of a owner (creator/editor) of the PDF file	[optional]
encryption_key_length	str	Possible values are "128" (128-bit RC4 encryption) and "256" (256-bit AES encryption). Default is 256.	[optional]

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_get_annotations

GetPdfAnnotationsResult edit_pdf_get_annotations(input_file)

Get PDF annotations, including comments in the document

Enumerates the annotations, including comments and notes, in a PDF document.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.

try:
    # Get PDF annotations, including comments in the document
    api_response = api_instance.edit_pdf_get_annotations(input_file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_get_annotations: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.

Return type

GetPdfAnnotationsResult

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_get_async_job_status

EditPdfJobStatusResult edit_pdf_get_async_job_status(async_job_id)

Get the status and result of a PDF Batch Job

Returns the result of the Async Job - possible states can be STARTED or COMPLETED. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
async_job_id = 'async_job_id_example' # str | 

try:
    # Get the status and result of a PDF Batch Job
    api_response = api_instance.edit_pdf_get_async_job_status(async_job_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_get_async_job_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
async_job_id	str

Return type

EditPdfJobStatusResult

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_get_form_fields

PdfFormFields edit_pdf_get_form_fields(input_file)

Gets PDF Form fields and values

Encrypt a PDF document with a password. Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF. Set the password fields null to omit the given password.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.

try:
    # Gets PDF Form fields and values
    api_response = api_instance.edit_pdf_get_form_fields(input_file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_get_form_fields: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.

Return type

PdfFormFields

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_get_metadata

PdfMetadata edit_pdf_get_metadata(input_file)

Get PDF document metadata

Returns the metadata from the PDF document, including Title, Author, etc.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.

try:
    # Get PDF document metadata
    api_response = api_instance.edit_pdf_get_metadata(input_file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_get_metadata: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.

Return type

PdfMetadata

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_get_pdf_text_by_pages

PdfTextByPageResult edit_pdf_get_pdf_text_by_pages(input_file, text_formatting_mode=text_formatting_mode)

Get text in a PDF document by page

Gets the text in a PDF by page

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
text_formatting_mode = 'text_formatting_mode_example' # str | Optional; specify how whitespace should be handled when converting the document to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'. (optional)

try:
    # Get text in a PDF document by page
    api_response = api_instance.edit_pdf_get_pdf_text_by_pages(input_file, text_formatting_mode=text_formatting_mode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_get_pdf_text_by_pages: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
text_formatting_mode	str	Optional; specify how whitespace should be handled when converting the document to text. Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases. Default is 'preserveWhitespace'.	[optional]

Return type

PdfTextByPageResult

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_insert_pages

str edit_pdf_insert_pages(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation)

Insert, copy pages from one PDF document into another

Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document).

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
source_file = '/path/to/file.txt' # file | Source PDF file to copy pages from.
destination_file = '/path/to/file.txt' # file | Destination PDF file to copy pages into.
page_start_source = 56 # int | Page number (1 based) to start copying pages from (inclusive) in the Source file.
page_end_source = 56 # int | Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
page_insert_before_desitnation = 56 # int | Page number (1 based) to insert the pages before in the Destination file.

try:
    # Insert, copy pages from one PDF document into another
    api_response = api_instance.edit_pdf_insert_pages(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_insert_pages: %s\n" % e)

Parameters

Name	Type	Description
source_file	file	Source PDF file to copy pages from.
destination_file	file	Destination PDF file to copy pages into.
page_start_source	int	Page number (1 based) to start copying pages from (inclusive) in the Source file.
page_end_source	int	Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
page_insert_before_desitnation	int	Page number (1 based) to insert the pages before in the Destination file.

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_insert_pages_batch_job

EditPdfBatchJobCreateResult edit_pdf_insert_pages_batch_job(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation)

Insert, copy pages from one PDF document into another as a batch job

Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document). Runs as a batch job async and returns a batch job ID that you can check the status of to get the result. Requires Cloudmersive Private Cloud or Managed Instance.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
source_file = '/path/to/file.txt' # file | Source PDF file to copy pages from.
destination_file = '/path/to/file.txt' # file | Destination PDF file to copy pages into.
page_start_source = 56 # int | Page number (1 based) to start copying pages from (inclusive) in the Source file.
page_end_source = 56 # int | Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
page_insert_before_desitnation = 56 # int | Page number (1 based) to insert the pages before in the Destination file.

try:
    # Insert, copy pages from one PDF document into another as a batch job
    api_response = api_instance.edit_pdf_insert_pages_batch_job(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_insert_pages_batch_job: %s\n" % e)

Parameters

Name	Type	Description
source_file	file	Source PDF file to copy pages from.
destination_file	file	Destination PDF file to copy pages into.
page_start_source	int	Page number (1 based) to start copying pages from (inclusive) in the Source file.
page_end_source	int	Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
page_insert_before_desitnation	int	Page number (1 based) to insert the pages before in the Destination file.

Return type

EditPdfBatchJobCreateResult

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_linearize

str edit_pdf_linearize(input_file)

Linearize and optimize a PDF for streaming download

Linearizes the content of a PDF to optimize it for streaming download, particularly over web streaming.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.

try:
    # Linearize and optimize a PDF for streaming download
    api_response = api_instance.edit_pdf_linearize(input_file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_linearize: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_rasterize

str edit_pdf_rasterize(input_file, dpi=dpi)

Rasterize a PDF to an image-based PDF

Rasterize a PDF into an image-based PDF. The output is a PDF where each page is comprised of a high-resolution image, with all text, figures and other components removed.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
dpi = 56 # int | Optional; configures the pixel density in Dots per Inch (DPI) (default is 300).  This parameter can only be used with Cloudmersive Managed Instance and Private Cloud. (optional)

try:
    # Rasterize a PDF to an image-based PDF
    api_response = api_instance.edit_pdf_rasterize(input_file, dpi=dpi)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_rasterize: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
dpi	int	Optional; configures the pixel density in Dots per Inch (DPI) (default is 300). This parameter can only be used with Cloudmersive Managed Instance and Private Cloud.	[optional]

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_rasterize_batch_job

EditPdfBatchJobCreateResult edit_pdf_rasterize_batch_job(input_file)

Rasterize a PDF to an image-based PDF as Batch Job

Rasterize a PDF into an image-based PDF. The output is a PDF where each page is comprised of a high-resolution image, with all text, figures and other components removed.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.

try:
    # Rasterize a PDF to an image-based PDF as Batch Job
    api_response = api_instance.edit_pdf_rasterize_batch_job(input_file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_rasterize_batch_job: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.

Return type

EditPdfBatchJobCreateResult

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_reduce_file_size

str edit_pdf_reduce_file_size(input_file, quality=quality)

Reduce the file size and optimize a PDF

Reduces the file size and optimizes the content of a PDF to minimize its file size.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
quality = 8.14 # float | Quality level for the images in the PDF, ranging from 0.0 (low quality) to 1.0 (high quality); default is 0.3 (optional)

try:
    # Reduce the file size and optimize a PDF
    api_response = api_instance.edit_pdf_reduce_file_size(input_file, quality=quality)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_reduce_file_size: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
quality	float	Quality level for the images in the PDF, ranging from 0.0 (low quality) to 1.0 (high quality); default is 0.3	[optional]

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_remove_all_annotations

str edit_pdf_remove_all_annotations(input_file)

Remove all PDF annotations, including comments in the document

Removes all of the annotations, including comments and notes, in a PDF document.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.

try:
    # Remove all PDF annotations, including comments in the document
    api_response = api_instance.edit_pdf_remove_all_annotations(input_file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_remove_all_annotations: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_remove_annotation_item

str edit_pdf_remove_annotation_item(input_file, annotation_index)

Remove a specific PDF annotation, comment in the document

Removes a specific annotation in a PDF document, using the AnnotationIndex. To enumerate AnnotationIndex for all of the annotations in the PDF document, use the /edit/pdf/annotations/list API.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
annotation_index = 56 # int | The 0-based index of the annotation in the document

try:
    # Remove a specific PDF annotation, comment in the document
    api_response = api_instance.edit_pdf_remove_annotation_item(input_file, annotation_index)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_remove_annotation_item: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
annotation_index	int	The 0-based index of the annotation in the document

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_resize

str edit_pdf_resize(input_file, paper_size)

Change PDF Document's Paper Size

Resizes a PDF document's paper size.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
paper_size = 'paper_size_example' # str | The desired paper size for the resized PDF document. Size ranges from A7 (smallest) to A0 (largest).

try:
    # Change PDF Document's Paper Size
    api_response = api_instance.edit_pdf_resize(input_file, paper_size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_resize: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
paper_size	str	The desired paper size for the resized PDF document. Size ranges from A7 (smallest) to A0 (largest).

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_rotate_all_pages

str edit_pdf_rotate_all_pages(input_file, rotation_angle)

Rotate all pages in a PDF document

Rotate all of the pages in a PDF document by a multiple of 90 degrees

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
rotation_angle = 56 # int | The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc.

try:
    # Rotate all pages in a PDF document
    api_response = api_instance.edit_pdf_rotate_all_pages(input_file, rotation_angle)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_rotate_all_pages: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
rotation_angle	int	The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc.

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_rotate_page_range

str edit_pdf_rotate_page_range(input_file, rotation_angle, page_start, page_end)

Rotate a range, subset of pages in a PDF document

Rotate a range of specific pages in a PDF document by a multiple of 90 degrees

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
rotation_angle = 56 # int | The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc.
page_start = 56 # int | Page number (1 based) to start rotating pages from (inclusive).
page_end = 56 # int | Page number (1 based) to stop rotating pages from (inclusive).

try:
    # Rotate a range, subset of pages in a PDF document
    api_response = api_instance.edit_pdf_rotate_page_range(input_file, rotation_angle, page_start, page_end)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_rotate_page_range: %s\n" % e)

Parameters

Name	Type	Description
input_file	file	Input file to perform the operation on.
rotation_angle	int	The angle to rotate the page in degrees, must be a multiple of 90 degrees, e.g. 90, 180, 270, or -90, -180, -270, etc.
page_start	int	Page number (1 based) to start rotating pages from (inclusive).
page_end	int	Page number (1 based) to stop rotating pages from (inclusive).

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_set_form_fields

str edit_pdf_set_form_fields(field_values)

Sets ands fills PDF Form field values

Fill in the form fields in a PDF form with specific values. Use form/get-fields to enumerate the available fields and their data types in an input form.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
field_values = cloudmersive_convert_api_client.SetPdfFormFieldsRequest() # SetPdfFormFieldsRequest | 

try:
    # Sets ands fills PDF Form field values
    api_response = api_instance.edit_pdf_set_form_fields(field_values)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_set_form_fields: %s\n" % e)

Parameters

Name	Type	Description	Notes
field_values	SetPdfFormFieldsRequest

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_set_metadata

str edit_pdf_set_metadata(request)

Sets PDF document metadata

Sets (writes) metadata into the input PDF document, including Title, Author, etc.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
request = cloudmersive_convert_api_client.SetPdfMetadataRequest() # SetPdfMetadataRequest | 

try:
    # Sets PDF document metadata
    api_response = api_instance.edit_pdf_set_metadata(request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_set_metadata: %s\n" % e)

Parameters

Name	Type	Description	Notes
request	SetPdfMetadataRequest

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_set_permissions

str edit_pdf_set_permissions(owner_password, user_password, input_file, encryption_key_length=encryption_key_length, allow_printing=allow_printing, allow_document_assembly=allow_document_assembly, allow_content_extraction=allow_content_extraction, allow_form_filling=allow_form_filling, allow_editing=allow_editing, allow_annotations=allow_annotations, allow_degraded_printing=allow_degraded_printing)

Encrypt, password-protect and set restricted permissions on a PDF

Encrypt a PDF document with a password, and set permissions on the PDF. Set an owner password to control owner (editor/creator) permissions [required], and set a user (reader) password to control the viewer of the PDF [optional]. Set the reader password to null to omit the password. Restrict or allow printing, copying content, document assembly, editing (read-only), form filling, modification of annotations, and degraded printing through document Digital Rights Management (DRM).

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
owner_password = 'owner_password_example' # str | Password of a owner (creator/editor) of the PDF file (required)
user_password = 'user_password_example' # str | Password of a user (reader) of the PDF file (optional)
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
encryption_key_length = 'encryption_key_length_example' # str | Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption).  Default is 256. (optional)
allow_printing = true # bool | Set to false to disable printing through DRM.  Default is true. (optional)
allow_document_assembly = true # bool | Set to false to disable document assembly through DRM.  Default is true. (optional)
allow_content_extraction = true # bool | Set to false to disable copying/extracting content out of the PDF through DRM.  Default is true. (optional)
allow_form_filling = true # bool | Set to false to disable filling out form fields in the PDF through DRM.  Default is true. (optional)
allow_editing = true # bool | Set to false to disable editing in the PDF through DRM (making the PDF read-only).  Default is true. (optional)
allow_annotations = true # bool | Set to false to disable annotations and editing of annotations in the PDF through DRM.  Default is true. (optional)
allow_degraded_printing = true # bool | Set to false to disable degraded printing of the PDF through DRM.  Default is true. (optional)

try:
    # Encrypt, password-protect and set restricted permissions on a PDF
    api_response = api_instance.edit_pdf_set_permissions(owner_password, user_password, input_file, encryption_key_length=encryption_key_length, allow_printing=allow_printing, allow_document_assembly=allow_document_assembly, allow_content_extraction=allow_content_extraction, allow_form_filling=allow_form_filling, allow_editing=allow_editing, allow_annotations=allow_annotations, allow_degraded_printing=allow_degraded_printing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_set_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner_password	str	Password of a owner (creator/editor) of the PDF file (required)
user_password	str	Password of a user (reader) of the PDF file (optional)
input_file	file	Input file to perform the operation on.
encryption_key_length	str	Possible values are "128" (128-bit RC4 encryption) and "256" (256-bit AES encryption). Default is 256.	[optional]
allow_printing	bool	Set to false to disable printing through DRM. Default is true.	[optional]
allow_document_assembly	bool	Set to false to disable document assembly through DRM. Default is true.	[optional]
allow_content_extraction	bool	Set to false to disable copying/extracting content out of the PDF through DRM. Default is true.	[optional]
allow_form_filling	bool	Set to false to disable filling out form fields in the PDF through DRM. Default is true.	[optional]
allow_editing	bool	Set to false to disable editing in the PDF through DRM (making the PDF read-only). Default is true.	[optional]
allow_annotations	bool	Set to false to disable annotations and editing of annotations in the PDF through DRM. Default is true.	[optional]
allow_degraded_printing	bool	Set to false to disable degraded printing of the PDF through DRM. Default is true.	[optional]

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_pdf_watermark_text

str edit_pdf_watermark_text(watermark_text, input_file, font_name=font_name, font_size=font_size, font_color=font_color, font_transparency=font_transparency)

Add a text watermark to a PDF

Adds a text watermark to a PDF

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditPdfApi(cloudmersive_convert_api_client.ApiClient(configuration))
watermark_text = 'watermark_text_example' # str | Watermark text to add to the PDF (required)
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
font_name = 'font_name_example' # str | Font Family Name for the watermark text; default is Times New Roman (optional)
font_size = 8.14 # float | Font Size in points of the text; default is 150 (optional)
font_color = 'font_color_example' # str | Font color in hexadecimal or HTML color name; default is Red (optional)
font_transparency = 8.14 # float | Font transparency between 0.0 (completely transparent) to 1.0 (fully opaque); default is 0.5 (optional)

try:
    # Add a text watermark to a PDF
    api_response = api_instance.edit_pdf_watermark_text(watermark_text, input_file, font_name=font_name, font_size=font_size, font_color=font_color, font_transparency=font_transparency)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditPdfApi->edit_pdf_watermark_text: %s\n" % e)

Parameters

Name	Type	Description	Notes
watermark_text	str	Watermark text to add to the PDF (required)
input_file	file	Input file to perform the operation on.
font_name	str	Font Family Name for the watermark text; default is Times New Roman	[optional]
font_size	float	Font Size in points of the text; default is 150	[optional]
font_color	str	Font color in hexadecimal or HTML color name; default is Red	[optional]
font_transparency	float	Font transparency between 0.0 (completely transparent) to 1.0 (fully opaque); default is 0.5	[optional]

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

EditPdfApi.md

Latest commit

History

EditPdfApi.md

File metadata and controls

cloudmersive_convert_api_client.EditPdfApi

edit_pdf_add_annotations

Example

Parameters

Return type

Authorization

HTTP request headers

edit_pdf_convert_to_pdf_a

Example

Parameters

Return type

Authorization

HTTP request headers

edit_pdf_decrypt

Example

Parameters

Return type

Authorization

HTTP request headers

edit_pdf_delete_pages

Example

Parameters

Return type

Authorization

HTTP request headers

edit_pdf_delete_pages_batch_job

Example

Parameters

Return type

Authorization

HTTP request headers

edit_pdf_encrypt

Example

Parameters

Return type

Authorization

HTTP request headers

edit_pdf_get_annotations

Example

Parameters

Return type

Authorization

HTTP request headers

edit_pdf_get_async_job_status

Example

Parameters

Return type

Authorization

HTTP request headers

edit_pdf_get_form_fields

Example

Parameters

Return type

Authorization

HTTP request headers

edit_pdf_get_metadata

Example

Parameters

Return type

Authorization

HTTP request headers

edit_pdf_get_pdf_text_by_pages

Example

Parameters

Return type

Authorization

HTTP request headers

edit_pdf_insert_pages

Example

Parameters

Return type

Authorization

HTTP request headers

edit_pdf_insert_pages_batch_job