How to Validate Rich Text Format Documents (RTF) in Python

While Rich Text Format (RTF) documents don’t have a true schema/definition, it’s still important to validate these documents in our file processing workflows as they can contain improper syntax or malicious code. Using the code provided below, you can easily validate RTF documents via our RTF Validation API and find out if they are password protected or contain any errors or warnings.

To install the SDK, run the following command:

pip install cloudmersive-convert-api-client

To structure your API call, copy in the imports and function below:

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'



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

try:
    # Validate a Rich Text Format document (RTF)
    api_response = api_instance.validate_document_rtf_validation(input_file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ValidateDocumentApi->validate_document_rtf_validation: %s\n" % e)

To complete your API call, you’ll just need to register a free account on our website and copy your free-tier API key into the configuration.api_key field above. Free API keys come with a limit of 800 API calls per month and zero additional commitments.

After that, you’re good to go!