cloudmersive_convert_api_client.SplitDocumentApi

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

Method	HTTP request	Description
split_document_batch_job_create	POST /convert/split/batch-job/create	Split a single Document into Separate Documents by Page as a Batch Job
split_document_docx	POST /convert/split/docx	Split a single Word Document DOCX into Separate Documents by Page
split_document_get_async_job_status	GET /convert/split/batch-job/status	Get the status and result of a Split Document Batch Job
split_document_pdf_by_page	POST /convert/split/pdf	Split a PDF file into separate PDF files, one per page
split_document_pptx	POST /convert/split/pptx	Split a single PowerPoint Presentation PPTX into Separate Slides
split_document_pptx_advanced	POST /convert/split/pptx/advanced	Split a single PowerPoint Presentation PPTX into Separate Presentations
split_document_txt_by_line	POST /convert/split/txt/by-line	Split a single Text file (txt) into lines
split_document_txt_by_string	POST /convert/split/txt/by-string	Split a single Text file (txt) by a string delimiter
split_document_xlsx	POST /convert/split/xlsx	Split a single Excel XLSX into Separate Worksheets

split_document_batch_job_create

SplitBatchJobCreateResult split_document_batch_job_create(input_file, return_document_contents=return_document_contents)

Split a single Document into Separate Documents by Page as a Batch Job

Split a Document (PPTX supported), comprised of multiple pages into separate files, with each containing exactly one page. This API is designed for large jobs that could take a long time to create and so runs as a batch job that returns a Job ID that you can use with the GetAsyncJobStatus API to check on the status of the Job and ultimately get the output result. This API automatically detects the document type and then performs the split by using the document type-specific API needed to perform the split. 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.SplitDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
return_document_contents = true # bool | Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation.  Default is true. (optional)

try:
    # Split a single Document into Separate Documents by Page as a Batch Job
    api_response = api_instance.split_document_batch_job_create(input_file, return_document_contents=return_document_contents)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SplitDocumentApi->split_document_batch_job_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
return_document_contents	bool	Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation. Default is true.	[optional]

Return type

SplitBatchJobCreateResult

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]

split_document_docx

SplitDocxDocumentResult split_document_docx(input_file, return_document_contents=return_document_contents)

Split a single Word Document DOCX into Separate Documents by Page

Split a Word DOCX Document, comprised of multiple pages into separate Word DOCX document files, with each containing exactly one 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.SplitDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
return_document_contents = true # bool | Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting document.  Default is true. (optional)

try:
    # Split a single Word Document DOCX into Separate Documents by Page
    api_response = api_instance.split_document_docx(input_file, return_document_contents=return_document_contents)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SplitDocumentApi->split_document_docx: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
return_document_contents	bool	Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting document. Default is true.	[optional]

Return type

SplitDocxDocumentResult

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]

split_document_get_async_job_status

JobStatusResult split_document_get_async_job_status(async_job_id)

Get the status and result of a Split Document 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.SplitDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
async_job_id = 'async_job_id_example' # str | 

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

Parameters

Name	Type	Description	Notes
async_job_id	str

Return type

JobStatusResult

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]

split_document_pdf_by_page

SplitPdfResult split_document_pdf_by_page(input_file, return_document_contents=return_document_contents)

Split a PDF file into separate PDF files, one per page

Split an input PDF file into separate pages, comprised of one PDF file per 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.SplitDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
return_document_contents = true # bool | Set to true to directly return all of the document contents in the DocumentContents field; set to false to return contents as temporary URLs (more efficient for large operations).  Default is false. (optional)

try:
    # Split a PDF file into separate PDF files, one per page
    api_response = api_instance.split_document_pdf_by_page(input_file, return_document_contents=return_document_contents)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SplitDocumentApi->split_document_pdf_by_page: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
return_document_contents	bool	Set to true to directly return all of the document contents in the DocumentContents field; set to false to return contents as temporary URLs (more efficient for large operations). Default is false.	[optional]

Return type

SplitPdfResult

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]

split_document_pptx

SplitPptxPresentationResult split_document_pptx(input_file, return_document_contents=return_document_contents)

Split a single PowerPoint Presentation PPTX into Separate Slides

Split an PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentation files, with each containing exactly one slide.

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.SplitDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
return_document_contents = true # bool | Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation.  Default is true. (optional)

try:
    # Split a single PowerPoint Presentation PPTX into Separate Slides
    api_response = api_instance.split_document_pptx(input_file, return_document_contents=return_document_contents)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SplitDocumentApi->split_document_pptx: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
return_document_contents	bool	Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation. Default is true.	[optional]

Return type

SplitPptxPresentationResult

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]

split_document_pptx_advanced

PptxSplitAdvancedResponse split_document_pptx_advanced(request)

Split a single PowerPoint Presentation PPTX into Separate Presentations

Split a PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentations of customizeable 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.SplitDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
request = cloudmersive_convert_api_client.PptxSplitAdvancedRequest() # PptxSplitAdvancedRequest | 

try:
    # Split a single PowerPoint Presentation PPTX into Separate Presentations
    api_response = api_instance.split_document_pptx_advanced(request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SplitDocumentApi->split_document_pptx_advanced: %s\n" % e)

Parameters

Name	Type	Description	Notes
request	PptxSplitAdvancedRequest

Return type

PptxSplitAdvancedResponse

Authorization

Apikey

HTTP request headers

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

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

split_document_txt_by_line

SplitTextDocumentByLinesResult split_document_txt_by_line(input_file)

Split a single Text file (txt) into lines

Split a Text (txt) Document by line, returning each line separately in order. Supports multiple types of newlines.

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.SplitDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.

try:
    # Split a single Text file (txt) into lines
    api_response = api_instance.split_document_txt_by_line(input_file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SplitDocumentApi->split_document_txt_by_line: %s\n" % e)

Parameters

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

Return type

SplitTextDocumentByLinesResult

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]

split_document_txt_by_string

SplitTextDocumentByStringResult split_document_txt_by_string(input_file, split_delimiter, skip_empty_elements=skip_empty_elements)

Split a single Text file (txt) by a string delimiter

Split a Text (txt) Document by a string delimiter, returning each component of the string as an array of strings.

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.SplitDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
split_delimiter = 'split_delimiter_example' # str | Required; String to split up the input file on
skip_empty_elements = true # bool | Optional; If true, empty elements will be skipped in the output (optional)

try:
    # Split a single Text file (txt) by a string delimiter
    api_response = api_instance.split_document_txt_by_string(input_file, split_delimiter, skip_empty_elements=skip_empty_elements)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SplitDocumentApi->split_document_txt_by_string: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
split_delimiter	str	Required; String to split up the input file on
skip_empty_elements	bool	Optional; If true, empty elements will be skipped in the output	[optional]

Return type

SplitTextDocumentByStringResult

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]

split_document_xlsx

SplitXlsxWorksheetResult split_document_xlsx(input_file, return_document_contents=return_document_contents)

Split a single Excel XLSX into Separate Worksheets

Split an Excel XLSX Spreadsheet, comprised of multiple Worksheets (or Tabs) into separate Excel XLSX spreadsheet files, with each containing exactly one Worksheet.

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.SplitDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
return_document_contents = true # bool | Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting worksheet.  Default is true. (optional)

try:
    # Split a single Excel XLSX into Separate Worksheets
    api_response = api_instance.split_document_xlsx(input_file, return_document_contents=return_document_contents)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SplitDocumentApi->split_document_xlsx: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.
return_document_contents	bool	Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting worksheet. Default is true.	[optional]

Return type

SplitXlsxWorksheetResult

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]

Files

SplitDocumentApi.md

Latest commit

History

SplitDocumentApi.md

File metadata and controls

cloudmersive_convert_api_client.SplitDocumentApi

split_document_batch_job_create

Example

Parameters

Return type

Authorization

HTTP request headers

split_document_docx

Example

Parameters

Return type

Authorization

HTTP request headers

split_document_get_async_job_status

Example

Parameters

Return type

Authorization

HTTP request headers

split_document_pdf_by_page

Example

Parameters

Return type

Authorization

HTTP request headers

split_document_pptx

Example

Parameters

Return type

Authorization

HTTP request headers

split_document_pptx_advanced

Example

Parameters

Return type

Authorization

HTTP request headers

split_document_txt_by_line

Example

Parameters

Return type

Authorization

HTTP request headers

split_document_txt_by_string

Example

Parameters

Return type

Authorization

HTTP request headers

split_document_xlsx

Example

Parameters

Return type

Authorization

HTTP request headers