README.md

ComPDFKit API in Python

ComPDFKit API provides a variety of Python API tools that allow you to create an efficient document processing workflow in a single API call. Try our various APIs for free — no credit card required.

Requirements

Programming Environment: Python 3.8 and higher.

Dependencies: pip.

Installation

You can install the library via pip. Run the following command:

pip install compdfkit-api-python

Create API Client

You can use your publicKey and secretKey to complete the authentication. You need to sign in your ComPDFKit API account to get your publicKey and secretKey at the dashboard. If you are new to ComPDFKit, click here to sign up for a free trial.

• Project public Key : You can find the public key in Management Panel.

• Project secret Key : You can find the secret Key in Management Panel.

# Create a client
client = CPDFClient(public_key, secret_key)

Create Task

A task ID is automatically generated for you based on the type of PDF tool you choose. You can provide the callback notification URL. After the task processing is completed, we will notify you of the task result through the callback interface. You can perform other operations according to the request result, such as checking the status of the task, uploading files, starting the task, or downloading the result file.

# Create a client
client = CPDFClient(public_key, secret_key)

# Create a task
# Create an example of a PDF TO WORD task
create_task_result = client.create_task(CPDFConversionEnum.PDF_TO_WORD)

# Get a task id
task_id = create_task_result.task_id

Upload Files

Upload the original file and bind the file to the task ID. The field parameter is used to pass the JSON string to set the processing parameters for the file. Each file will generate automatically a unique filekey. Please note that a maximum of five files can be uploaded for a task ID and no files can be uploaded for that task after it has started.

# Create a client
client = CPDFClient(public_key, secret_key)

# Create a task
# Create an example of a PDF TO WORD task
create_task_result = client.create_task(CPDFConversionEnum.PDF_TO_WORD)

# Get a task id
task_id = create_task_result.task_id

# Upload files
client.upload_file(convert_file, task_id)

Execute the task

After the file upload is completed, call this interface with the task ID to process the files.

# Create a client
client = CPDFClient(public_key, secret_key)

# Create a task
# Create an example of a PDF TO WORD task
create_task_result = client.create_task(CPDFConversionEnum.PDF_TO_WORD)

# Get a task id
task_id = create_task_result.task_id

# Upload files
client.upload_file(convert_file, task_id)

# execute Task
client.execute_task(task_id)

Get Task Info

Request task status and file-related meta data based on the task ID.

# Create a client
client = CPDFClient(public_key, secret_key)

# Create a task
# Create an example of a PDF TO WORD task
create_task_result = client.create_task(CPDFConversionEnum.PDF_TO_WORD)

# Get a task id
task_id = create_task_result.task_id

# Upload files
client.upload_file(convert_file, task_id)

# execute Task
client.execute_task(task_id)

# Query TaskInfo
task_info = client.get_task_info(task_id)

Samples

See "Samples" folder in this folder.

Resources

• ComPDFKit API Documentation