Adobe PDF Services Python SDK

https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/
Admin
The Adobe PDF Services Python SDK provides an API for developers to programmatically interact with...
Tokens:107,793
Snippets:604
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### ProxyServerConfig JSON Example

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices.operation.config

An example JSON structure for configuring a proxy server, including host, port, scheme, and username/password credentials. This format is used by the `from_json` method of `ProxyServerConfig`.

```json
{
"proxyServerConfig": {
        "host": "127.0.0.1",
        "port": "8080",
        "scheme": "https",
        "usernamePasswordCredentials": {
            "username": "username",
            "password": "password"
        }
    },
}
```

--------------------------------

### ClientConfig Methods

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Provides methods to get PDF Services URI and proxy server configuration.

```APIDOC
## GET /api/config/client

### Description
Retrieves the PDF Services URI and proxy server configuration for the client.

### Method
GET

### Endpoint
/api/config/client

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body needed for this operation."
}
```

### Response
#### Success Response (200)
- **pdfServicesUri** (string) - The URI for the PDF Services API.
- **proxyServerConfig** (object) - Configuration details for the proxy server.

#### Response Example
```json
{
  "pdfServicesUri": "https://pdfservices.adobe.io/rest/v1",
  "proxyServerConfig": {
    "host": "proxy.example.com",
    "port": 8080
  }
}
```
```

--------------------------------

### CompressPDFResult Asset Retrieval in Python

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices.operation

Shows how to get the compressed PDF asset from the CompressPDFResult object.

```Python
from adobe.pdfservices.operation.pdfjobs.result.compress_pdf_result import CompressPDFResult

# Example usage:
compress_result = CompressPDFResult()
asset = compress_result.get_asset()
```

--------------------------------

### Adobe PDF Services Client Configuration

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Provides methods for configuring the PDF Services client, including loading from a file.

```python
from adobe.pdfservices.operation.config.client_config import ClientConfig

# Example usage:
# Assuming 'config.json' exists with client configuration
# client_config = ClientConfig.from_file('config.json')
```

--------------------------------

### Get Page Start Information

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the start page number for PDF operations. This method is part of the PDFAccessibilityCheckerParams class.

```python
from adobe.pdfservices.operation.pdfjobs.params.pdf_accessibility_checker.pdf_accessibility_checker_params import PDFAccessibilityCheckerParams

# Assuming 'params' is an instance of PDFAccessibilityCheckerParams
# page_start = params.get_page_start()
```

--------------------------------

### Get Start Page for Page Range

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the start page number for a specified page range. This method is part of the PageRange class.

```python
from adobe.pdfservices.operation.internal.params.page_range import PageRange

# Assuming 'page_range' is an instance of PageRange
# start_page = page_range.get_start()
```

--------------------------------

### Initialize PDF Services Client

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/index

Constructs a new PDFServices instance with the provided Credentials and optional ClientConfig. This is the entry point for all PDF Service utilities.

```python
from adobe.pdfservices.operation.pdf_services import PDFServices

# Assuming 'credentials' and 'client_config' are already defined
pdf_services = PDFServices(credentials, client_config)
```

--------------------------------

### Initialize PDFServices Instance

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices

Constructs a new PDFServices instance. Requires Credentials and optionally accepts ClientConfig for PDFServices configuration. This is the entry point for all PDF Service operations.

```python
from adobe.pdfservices.operation import PDFServices
from adobe.pdfservices.credentials import Credentials
from adobe.pdfservices.configuration import ClientConfig

# Assuming credentials and client_config are already initialized
credentials = Credentials('user_email', 'client_id', 'client_secret', 'tenant_id', 'account_id')
client_config = ClientConfig()

pdf_services = PDFServices(credentials, client_config=client_config)
```

--------------------------------

### Configuration Modules

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices

Overview of configuration options for the PDF Services client.

```APIDOC
## Configuration Modules

This section describes the configuration aspects of the Adobe PDF Services Python SDK, allowing customization of client behavior.

### `adobe.pdfservices.operation.config.client_config`

This module provides the `ClientConfig` class for configuring the PDF Services client.

*   **`ClientConfig`**: Represents the client configuration.
    *   `from_file()`: Creates a configuration from a file.
    *   `get_connect_timeout()`: Retrieves the connection timeout setting.
    *   `get_pdf_services_uri()`: Retrieves the URI for PDF Services.
    *   `get_proxy_server_config()`: Retrieves the proxy server configuration.
    *   `get_read_timeout()`: Retrieves the read timeout setting.
    *   `validate()`: Validates the client configuration.

### `adobe.pdfservices.operation.config.notifier`

This subpackage contains modules related to notification configurations, including:

*   `callback_notifier_data`
*   `notifier_config`
*   `notifier_data`
*   `notifier_type`

### `adobe.pdfservices.operation.config.proxy`

This subpackage provides classes for configuring proxy settings:

*   `proxy_authentication_credentials`
*   `proxy_scheme`
*   `proxy_server_config`
*   `username_password_credentials`
```

--------------------------------

### PageRanges Class

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/pdfjobs/params

Defines and manages page ranges for PDF operations. Supports adding all pages, ranges from a start page, specific ranges, and single pages. Page indexing starts from 1.

```python
from adobe.pdfservices.operation.pdfjobs.params.page_ranges import PageRanges

# Example usage:
page_ranges = PageRanges()
page_ranges.add_all()
page_ranges.add_range(1, 5)
page_ranges.add_single_page(10)
```

--------------------------------

### GET /asset/content

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/index

Retrieves the content of a specified asset.

```APIDOC
## GET /asset/content

### Description
Retrieves the content of a specified asset.

### Method
GET

### Endpoint
/asset/content

### Parameters
#### Path Parameters
- **asset** (Asset) - Required - The asset object whose content is to be retrieved.

### Returns
* **StreamAsset**: The content of the asset.

### Raises
* **ServiceApiException**: If an error is encountered while processing the request.
* **SdkException**: If a client-side or network error occurs.
```

--------------------------------

### Create ProxyServerConfig from JSON - Python

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/config/proxy

Demonstrates how to create a ProxyServerConfig instance from a JSON dictionary. It handles host, port, scheme, and username/password credentials.

```Python
from adobe.pdfservices.operation.config.proxy.proxy_server_config import ProxyServerConfig
from adobe.pdfservices.operation.config.proxy.username_password_credentials import UsernamePasswordCredentials

json_data = {
    "proxyServerConfig": {
            "host": "127.0.0.1",
            "port": "8080",
            "scheme": "https",
            "usernamePasswordCredentials": {
                "username": "username",
                "password": "password"
            }
        }
    }

proxy_config = ProxyServerConfig.from_json(json_data)
```

--------------------------------

### Get Asset Content

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices

Retrieves the content of a specified asset.

```APIDOC
## GET /asset/content

### Description
Retrieves the content of a specified asset.

### Method
GET

### Endpoint
/asset/content

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
*   **asset** (_Asset_) – Asset to the content; can not be None.

### Response
#### Success Response (200)
*   **StreamAsset**: Returns the content of the asset.

#### Error Response
*   **ServiceApiException**: If an error is encountered while submitting the job.
*   **SdkException**: Is thrown for client-side or network errors.
```

--------------------------------

### Client Configuration and Operations

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Details methods related to client configuration and core operations within the PDF Services SDK.

```APIDOC
## Client Configuration and Operations

### Description
This section covers methods related to client configuration and general operation validation.

### Methods

- **validate() (adobe.pdfservices.operation.config.client_config.ClientConfig)**
  - **Description**: Validates the client configuration.
  - **Method**: Instance Method

- **validate() (adobe.pdfservices.operation.internal.execution_context.ExecutionContext)**
  - **Description**: Validates the execution context.
  - **Method**: Instance Method

- **validate() (adobe.pdfservices.operation.internal.params.page_range.PageRange)**
  - **Description**: Validates the page range.
  - **Method**: Instance Method

- **validate() (adobe.pdfservices.operation.pdfjobs.params.page_ranges.PageRanges)**
  - **Description**: Validates multiple page ranges.
  - **Method**: Instance Method
```

--------------------------------

### PDFServices Constructor

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/index

Initializes the PDFServices client with credentials and optional client configuration.

```APIDOC
## PDFServices Constructor

### Description
This class is the entry point for all the PDF Service utilities. These utilities can be used to perform various functions such as submitting `PDFServicesJob`, getting status of a `PDFServicesJob`, getting result of a `PDFServicesJob`, uploading `Asset`, getting content of an `Asset`, deleting an `Asset` and refreshing an `Asset`.

Constructs a new `PDFServices` instance with the given Credentials and ClientConfig.

### Parameters
* **credentials** (_Credentials_) – Credentials to be used for authentication; can not be None.
* **client_config** (_ClientConfig_) – Client configuration for PDFServices. (Optional, use key-value)
```

--------------------------------

### GET /job/{polling_url}/status

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/index

Retrieves the status of a submitted PDF Services job.

```APIDOC
## GET /job/{polling_url}/status

### Description
Returns PDFServicesJobStatusResponse for the submitted `PDFServicesJob`.

### Method
GET

### Endpoint
/job/{polling_url}/status

### Parameters
#### Path Parameters
- **polling_url** (str) - Required - The URL to be polled to get the job status.

### Returns
* **PDFServicesJobStatusResponse**: The status response for the submitted job.

### Raises
* **ServiceApiException**: If an error is encountered while processing the request.
* **SdkException**: If a client-side or network error occurs.
* **ServiceUsageException**: If service usage limits have been reached or credentials quota has been exhausted.
```

--------------------------------

### GET /job/{polling_url}/result

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/index

Retrieves the result of a submitted PDF Services job.

```APIDOC
## GET /job/{polling_url}/result

### Description
Returns PDFServicesResponse for the submitted `PDFServicesJob` result.

### Method
GET

### Endpoint
/job/{polling_url}/result

### Parameters
#### Path Parameters
- **polling_url** (str) - Required - The URL to be polled to get the job result.
- **result_type** (ABCMeta) - Required - The result class for `PDFServicesJob`, it will be an implementation of `PDFServicesJobResult`.

### Returns
* **PDFServicesResponse**: The response for the submitted job.

### Raises
* **ServiceApiException**: If an error is encountered while processing the request.
* **SdkException**: If a client-side or network error occurs.
```

--------------------------------

### PDFServices Class Initialization

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices

Initializes a new PDFServices instance with credentials and optional client configuration.

```APIDOC
## PDFServices Initialization

### Description
Constructs a new `PDFServices` instance with the given Credentials and ClientConfig.

### Parameters
*   **credentials** (_Credentials_) – Credentials to be used for authentication; can not be None.
*   **client_config** (_ClientConfig_) – Client configuration for PDFServices. (Optional, use key-value)
```

--------------------------------

### Get Permissions Values

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the set of permissions applied to a PDF.

```APIDOC
## GET /api/permissions/values

### Description
Fetches the collection of permissions that are set for a protected PDF document.

### Method
GET

### Endpoint
`/api/permissions/values`

### Response
#### Success Response (200)
- **permissions** (array) - A list of strings, each representing an allowed permission (e.g., "PRINT", "MODIFY").

#### Response Example
```json
{
  "permissions": [
    "PRINT",
    "COPY_CONTENT"
  ]
}
```
```

--------------------------------

### Get Token Type

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the type of token used for authentication.

```APIDOC
## GET /api/auth/token-type

### Description
Retrieves the type of authentication token being used for the current session or request.

### Method
GET

### Endpoint
`/api/auth/token-type`

### Response
#### Success Response (200)
- **tokenType** (string) - The type of the token (e.g., "Bearer", "API Key").

#### Response Example
```json
{
  "tokenType": "Bearer"
}
```
```

--------------------------------

### UsernamePasswordCredentials from JSON - Python

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/config/proxy

Shows how to construct a UsernamePasswordCredentials instance from a JSON dictionary, extracting username and password.

```Python
from adobe.pdfservices.operation.config.proxy.username_password_credentials import UsernamePasswordCredentials

json_data = {
    "username": "testuser",
    "password": "testpassword"
}

credentials = UsernamePasswordCredentials.from_json(json_data)
```

--------------------------------

### Get Signature Format (Python)

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/pdfjobs/params

Retrieves the signature format used for an electronic seal.

```python
signature_format = pdf_electronic_seal_params.get_signature_format()
```

--------------------------------

### Configuration

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/index

Provides options for configuring the PDF Services client.

```APIDOC
## Configuration API

### Description
This API allows for configuring various aspects of the PDF Services client, including notifier and proxy settings.

### Notifier Configuration

- **NotifierConfig**: General configuration for notifications.
- **CallbackNotifierData**: Data for callback notifications.
- **NotifierData**: Base class for notifier data.
- **NotifierType**: Enum for different notifier types.

### Proxy Configuration

- **ProxyServerConfig**: Configuration for the proxy server.
- **ProxyAuthenticationCredentials**: Credentials for proxy authentication.
- **UsernamePasswordCredentials**: Credentials for username/password authentication.
- **ProxyScheme**: Enum for different proxy schemes.

### Client Configuration

- **ClientConfig**: Main class for client configuration, encompassing notifier and proxy settings.
```

--------------------------------

### Get Job Status

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices

Retrieves the status of a submitted PDF Services job.

```APIDOC
## GET /jobs/status

### Description
Retrieves the status of a submitted PDF Services job.

### Method
GET

### Endpoint
/jobs/status

### Parameters
#### Path Parameters
None

#### Query Parameters
*   **polling_url** (_str_) – URL to be polled to get the job status; can not be None.

### Response
#### Success Response (200)
*   **PDFServicesJobStatusResponse**: Returns PDFServicesJobStatusResponse for the submitted `PDFServicesJob`.

#### Error Response
*   **ServiceApiException**: If an error is encountered while submitting the job.
*   **SdkException**: Is thrown for client-side or network errors.
*   **ServiceUsageException**: If service usage limits have been reached or credentials quota has been exhausted.
```

--------------------------------

### CallbackNotifierData Class Initialization (Python)

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/config/notifier

Illustrates the construction of the CallbackNotifierData class, which holds the configuration for callback notifications. It requires a URL and optionally accepts headers.

```python
from adobe.pdfservices.operation.config.notifier.callback_notifier_data import CallbackNotifierData

# Example usage:
callback_url = "https://example.com/callback"
callback_headers = {
    "Authorization": "Bearer YOUR_TOKEN"
}

callback_notifier_data = CallbackNotifierData(url=callback_url, headers=callback_headers)
```

--------------------------------

### UsernamePasswordCredentials

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/config/proxy

Concrete implementation of ProxyAuthenticationCredentials using a username and password.

```APIDOC
## Class: UsernamePasswordCredentials

### Description
Simple `ProxyAuthenticationCredentials` implementation based on a username and password.

### Methods

#### `__init__(self, username: str, password: str)`
Constructs an instance of `UsernamePasswordCredentials`.

**Parameters:**
- **username** (_str_) - Username. Cannot be none or empty.
- **password** (_str_) - Password. Cannot be none or empty.

#### `from_json(cls, json_data: dict)`
Constructs a `UsernamePasswordCredentials` instance from a dictionary in the specified format.

**Parameters:**
- **json_data** (_dict_) - JSON data in the form of a dictionary.

#### `get_password(self) -> str`
Returns the password.

**Returns:**
- _str_ - The password.

#### `get_username(self) -> str`
Returns the username.

**Returns:**
- _str_ - The username.
```

--------------------------------

### Get Job Result

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices

Retrieves the result of a submitted PDF Services job.

```APIDOC
## GET /jobs/result

### Description
Returns PDFServicesResponse for the submitted `PDFServicesJob` result.

### Method
GET

### Endpoint
/jobs/result

### Parameters
#### Path Parameters
None

#### Query Parameters
*   **polling_url** (_str_) – URL to be polled to get the job result; can not be None.
*   **result_type** (_ABCMeta_) – result class for `PDFServicesJob`, it will be an implementation of PDFServicesJobResult; can not be None.

### Response
#### Success Response (200)
*   **PDFServicesResponse**: Returns PDFServicesResponse for the submitted job.

#### Error Response
*   **ServiceApiException**: If an error is encountered while submitting the job.
*   **SdkException**: Is thrown for client-side or network errors.
```

--------------------------------

### Proxy Configuration

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Details on configuring proxy settings for client connections.

```APIDOC
## GET /api/config/proxy

### Description
This endpoint relates to the configuration of proxy server settings used for establishing client connections to the PDF Services API.

### Method
GET

### Endpoint
/api/config/proxy

### Parameters
#### Query Parameters
- **credentials** (object) - Optional - Proxy server credentials if required for authentication.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **proxySettings** (object) - Contains the configured proxy server settings.

#### Response Example
```json
{
  "example": "{\"proxySettings\": {}}"
}
```
```

--------------------------------

### PDFServicesJobStatus

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/index

Represents the status types for a PDFServicesJob. It includes methods to get the string representation of the status.

```APIDOC
## PDFServicesJobStatus

### Description
Status types for `PDFServicesJob`. Constructs PDF Services job status using its string representation.

### Class
`adobe.pdfservices.operation.pdf_services_job_status.PDFServicesJobStatus(_value_)

Bases: `Enum`

### Parameters
* **value** (_str_) - string representation of PDF services job status.

### Status Types
* **DONE** - Represents completed status
* **FAILED** - Represents failed status
* **IN_PROGRESS** - Represents in progress status

### Methods
* **get_value()** - Returns string representation of `PDFServicesJobStatus`.
```

--------------------------------

### Exception Handling

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Provides information on exception handling, specifically the `with_traceback` method for SDK and API exceptions.

```APIDOC
## Exception Handling

### Description
This section details exception handling methods, particularly the `with_traceback` method available for various exception types.

### Methods

- **with_traceback() (adobe.pdfservices.operation.exception.exceptions.SdkException)**
  - **Description**: Adds traceback information to an SDK exception.
  - **Method**: Instance Method

- **with_traceback() (adobe.pdfservices.operation.exception.exceptions.ServiceApiException)**
  - **Description**: Adds traceback information to a Service API exception.
  - **Method**: Instance Method

- **with_traceback() (adobe.pdfservices.operation.exception.exceptions.ServiceUsageException)**
  - **Description**: Adds traceback information to a Service Usage exception.
  - **Method**: Instance Method
```

--------------------------------

### Get Watermark Appearance

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the appearance settings for a watermark applied to a PDF.

```APIDOC
## GET /api/watermark/appearance

### Description
Fetches the visual properties (e.g., text, color, opacity, position) defining how a watermark appears on a PDF page.

### Method
GET

### Response
#### Success Response (200)
- **appearance** (object) - Details about the watermark's appearance.
  - **text** (string) - The text content of the watermark.
  - **opacity** (number) - The opacity level (0.0 to 1.0).
  - **color** (string) - The color of the watermark (e.g., "#CCCCCC").

#### Response Example
```json
{
  "appearance": {
    "text": "Confidential",
    "opacity": 0.5,
    "color": "#FF0000"
  }
}
```
```

--------------------------------

### Get Username for TSA Credentials

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the username for TSA basic authentication.

```APIDOC
## GET /api/credentials/tsa/username

### Description
Fetches the username required for basic authentication when interacting with a Time Stamping Authority (TSA) service.

### Method
GET

### Endpoint
`/api/credentials/tsa/username`

### Response
#### Success Response (200)
- **username** (string) - The username for TSA authentication.

#### Response Example
```json
{
  "username": "tsa_auth_user"
}
```
```

--------------------------------

### Adobe PDF Services Proxy Configuration

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Enables configuration of proxy servers for PDF Services operations, including loading from JSON and setting credentials.

```python
from adobe.pdfservices.operation.config.proxy.proxy_server_config import ProxyServerConfig
from adobe.pdfservices.operation.config.proxy.username_password_credentials import UsernamePasswordCredentials
from adobe.pdfservices.operation.internal.api.dto.response.pdf_services_api import PDFServicesAPIResponse

# Example usage for proxy configuration:
# proxy_config = ProxyServerConfig.from_json('{"host": "proxy.example.com", "port": 8080}')

# Example usage for credentials:
# credentials = UsernamePasswordCredentials.from_json('{"username": "user", "password": "pass"}')

# Example for API response processing (static method):
# api_response = PDFServicesAPIResponse.from_json('{"status": "success"}')
```

--------------------------------

### Get Username for Proxy Credentials

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the username used for proxy authentication.

```APIDOC
## GET /api/proxy/credentials/username

### Description
Retrieves the username configured for authenticating with a proxy server.

### Method
GET

### Endpoint
`/api/proxy/credentials/username`

### Response
#### Success Response (200)
- **username** (string) - The username for proxy authentication.

#### Response Example
```json
{
  "username": "proxy_user"
}
```
```

--------------------------------

### Client Configuration

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Information on client configuration, including connection timeouts.

```APIDOC
## GET /api/config/client

### Description
This endpoint provides details on client-side configurations, such as setting connection timeouts for API requests.

### Method
GET

### Endpoint
/api/config/client

### Parameters
#### Query Parameters
- **connectTimeout** (integer) - Optional - The timeout duration in milliseconds for establishing a connection.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **clientConfig** (object) - Contains the client configuration details.

#### Response Example
```json
{
  "example": "{\"clientConfig\": {}}"
}
```
```

--------------------------------

### Get User Password for Protection

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the user-defined password for protecting a PDF.

```APIDOC
## GET /api/protect/password

### Description
Fetches the password that has been set to protect a PDF document from unauthorized access or modification.

### Method
GET

### Response
#### Success Response (200)
- **userPassword** (string) - The password set for PDF protection.

#### Response Example
```json
{
  "userPassword": "MySecurePassword123"
}
```
```

--------------------------------

### PDF Creation Parameters

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Details on parameters used for creating PDFs from various file types, including options for tagged PDFs and document language.

```APIDOC
## GET /api/pdf/create

### Description
This endpoint is related to the creation of PDF documents from various sources like Word, Excel, and PowerPoint. It also supports options for creating tagged PDFs and setting the document language.

### Method
GET

### Endpoint
/api/pdf/create

### Parameters
#### Query Parameters
- **createTaggedPdf** (boolean) - Optional - Specifies whether to create a tagged PDF.
- **documentLanguage** (string) - Optional - Sets the primary language of the document.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success status of the operation.

#### Response Example
```json
{
  "example": "{\"status\": \"success\"}"
}
```
```

--------------------------------

### Get Upload URI

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the URI for uploading files to cloud storage.

```APIDOC
## POST /api/storage/upload-uri

### Description
Obtains a pre-signed URI to upload a file directly to the PDF Services cloud storage.

### Method
POST

### Endpoint
`/api/storage/upload-uri`

### Parameters
#### Request Body
- **fileName** (string) - Required - The name of the file to be uploaded.
- **fileSize** (integer) - Required - The size of the file in bytes.
- **contentType** (string) - Optional - The MIME type of the file.

### Response
#### Success Response (200)
- **uploadUri** (string) - The URI where the file should be uploaded.
- **storagePath** (string) - The path identifier for the uploaded file in storage.

#### Response Example
```json
{
  "uploadUri": "https://storage.adobe.com/upload?uploadId=...",
  "storagePath": "/uploads/12345/myfile.pdf"
}
```
```

--------------------------------

### Execution Context

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices

Manages the execution context for PDF Services operations, including authentication and client configuration.

```APIDOC
## Execution Context

Manages the context for executing PDF Services operations.

### `ExecutionContext`

Represents the execution context for PDF Services operations.

- **authenticator** (object) - The authenticator for the operation.
- **client_config** (object) - The client configuration for the operation.
- **credentials** (object) - The credentials for the operation.

### Methods
- **`validate()`** - Validates the execution context.
```

--------------------------------

### Get Service Token

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves an authentication token for accessing PDF Services.

```APIDOC
## POST /api/oauth/token

### Description
Obtains an access token required for authenticating requests to the PDF Services API.

### Method
POST

### Endpoint
`/api/oauth/token`

### Parameters
#### Request Body
- **grant_type** (string) - Required - The type of grant (e.g., "client_credentials").
- **client_id** (string) - Required - The client ID obtained from Adobe.
- **client_secret** (string) - Required - The client secret obtained from Adobe.

### Response
#### Success Response (200)
- **access_token** (string) - The obtained access token.
- **token_type** (string) - The type of the token (e.g., "Bearer").
- **expires_in** (integer) - The lifetime in seconds of the access token.

#### Response Example
```json
{
  "access_token": "<your_access_token>",
  "token_type": "Bearer",
  "expires_in": 3600
}
```
```

--------------------------------

### ProxyServerConfig

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/config/proxy

Encapsulates the proxy server configurations, allowing you to set the host, port, scheme (HTTP/HTTPS), and authentication credentials.

```APIDOC
## Class: ProxyServerConfig

### Description
Encapsulates the proxy server configurations. You can specify the host, port, scheme, and credentials for proxy authentication.

### Methods

#### `__init__(self, host: str, *, port: int = None, scheme: ProxyScheme = ProxyScheme.HTTP, credentials: ProxyAuthenticationCredentials = None)`
Creates an instance of `ProxyServerConfig`.

**Parameters:**
- **host** (_str_) - Host name of the proxy server. (Optional, use key-value)
- **port** (_int_) - Port number of the proxy server. It should be greater than 0. Scheme’s default port is used if not provided. (Optional, use key-value)
- **scheme** (_ProxyScheme_) - Scheme of the proxy server. Possible values are HTTP and HTTPS. Default value is HTTP. (Optional, use key-value)
- **credentials** (_ProxyAuthenticationCredentials_) - ProxyAuthenticationCredentials instance. (Optional, use key-value)

#### `from_json(cls, json_data: dict)`
Creates a proxy server instance from a JSON dictionary.

**Parameters:**
- **json_data** (_dict_) - A dictionary containing proxy server config in the specified format.

**Request Body Example:**
```json
{
  "proxyServerConfig": {
    "host": "127.0.0.1",
    "port": "8080",
    "scheme": "https",
    "usernamePasswordCredentials": {
      "username": "username",
      "password": "password"
    }
  }
}
```

#### `get_credentials(self)`
Returns the credentials for authenticating with a proxy server.

**Returns:**
- _ProxyAuthenticationCredentials_ - The proxy authentication credentials.

#### `get_host(self)`
Returns the host name of the proxy server.

**Returns:**
- _str_ - The host name.

#### `get_port(self)`
Returns the port number of the proxy server.

**Returns:**
- _int_ - The port number.

#### `get_proxy_scheme(self)`
Returns the scheme of the proxy server.

**Returns:**
- _ProxyScheme_ - The proxy scheme (HTTP or HTTPS).
```

--------------------------------

### Get Tagged PDF Status

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves information about whether a PDF has been tagged.

```APIDOC
## GET /api/autotag/status

### Description
Checks the status or properties related to whether a PDF has been automatically tagged for accessibility.

### Method
GET

### Endpoint
`/api/autotag/status`

### Response
#### Success Response (200)
- **isTagged** (boolean) - Indicates whether the PDF has been tagged.

#### Response Example
```json
{
  "isTagged": true
}
```
```

--------------------------------

### CreatePDFResult Asset Retrieval in Python

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices.operation

Illustrates fetching the created PDF asset using the CreatePDFResult object.

```Python
from adobe.pdfservices.operation.pdfjobs.result.create_pdf_result import CreatePDFResult

# Example usage:
create_result = CreatePDFResult()
asset = create_result.get_asset()
```

--------------------------------

### Get Styling Information

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves styling information for PDF extraction parameters.

```APIDOC
## GET /api/extract/style

### Description
Retrieves styling information relevant to the extraction of data from a PDF.

### Method
GET

### Endpoint
`/api/extract/style`

### Parameters
#### Query Parameters
- **outputFormat** (string) - Optional - Specifies the desired output format for styling information.

### Response
#### Success Response (200)
- **styleInfo** (object) - Contains details about the styling applied during extraction.

#### Response Example
```json
{
  "styleInfo": {
    "fontName": "Arial",
    "fontSize": 12,
    "color": "#000000"
  }
}
```
```

--------------------------------

### Get Permission Values

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the set of permission values configured for a PDF.

```Python
get_values()
```

--------------------------------

### Create PDF from DOCX using Adobe PDF Services SDK

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/pdfjobs/jobs

This example demonstrates how to convert a DOCX file to a PDF using the Adobe PDF Services Python SDK. It reads a DOCX file, uploads it, creates a CreatePDFJob, submits the job, and then retrieves the resulting PDF. This process is useful for document format conversion.

```python
file = open('SOURCE_PATH', 'rb')
input_stream = file.read()
file.close()
credentials = ServicePrincipalCredentials(
    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
)
pdf_services = PDFServices(credentials=credentials)
input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.DOCX)
create_pdf_job = CreatePDFJob(input_asset)
location = pdf_services.submit(create_pdf_job)
pdf_services_response = pdf_services.get_job_result(location, CreatePDFResult)
result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
stream_asset: StreamAsset = pdf_services.get_content(result_asset)
```

--------------------------------

### Get Create Tagged PDF Setting for Create PDF Params

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the setting for creating a tagged PDF. Tagging improves accessibility and structure for documents created from various sources like Excel, PPT, or Word.

```python
from adobe.pdfservices.operation.pdfjobs.params.create_pdf.CreatePDFParams import CreatePDFParams

create_pdf_params = CreatePDFParams()
create_pdf_params.set_create_tagged_pdf(True)
create_tagged_pdf = create_pdf_params.get_create_tagged_pdf()
```

--------------------------------

### Get TSA URL (Python)

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/pdfjobs/params

Retrieves the URL for the Time Stamp Authority (TSA) service.

```python
tsa_url = rfc3161_tsa_options.get_url()
```

--------------------------------

### Internal API Modules

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices

Overview of internal modules used for interacting with PDF Services APIs.

```APIDOC
## Internal API Modules

This section provides an overview of internal modules facilitating communication with the Adobe PDF Services APIs.

### `adobe.pdfservices.operation.internal.api`

This subpackage contains modules for specific API interactions:

*   `pdf_services_api`
*   `storage_api`

### `adobe.pdfservices.operation.internal.auth`

This subpackage includes modules related to internal authentication mechanisms:

*   `auth_factory`
*   `authenticator`
*   `service_principal_authenticator`
*   `service_token_authenticator`
*   `service_token_credentials`
*   `session_token`

### `adobe.pdfservices.operation.internal.constants`

This subpackage defines constants used throughout the SDK:

*   `custom_error_messages`
*   `operation_header_info_endpoint_map`
*   `pdf_services_uri`
*   `request_key`
*   `service_constants`

### `adobe.pdfservices.operation.internal.http`

This subpackage contains modules for handling HTTP requests and responses:

*   `http_client`
*   `http_method`
*   `http_request`
*   `request_header_const`
*   `response_util`

### `adobe.pdfservices.operation.internal.params`

This subpackage defines data structures for API parameters:

*   `combine_pdf_job_input`
*   `page_range`

### `adobe.pdfservices.operation.internal.util`

This subpackage provides utility functions for the SDK:

*   `asset_upload_util`
*   `enforce_types`
*   `file_utils`
```

--------------------------------

### Get Seal Appearance Options (Python)

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/pdfjobs/params

Retrieves the appearance options configured for a PDF seal.

```python
appearance_options = pdf_electronic_seal_params.get_seal_appearance_options()
```

--------------------------------

### Authentication Modules

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices

Details on authentication mechanisms and credential management within the SDK.

```APIDOC
## Authentication Modules

This section details the modules related to authentication and credential handling in the Adobe PDF Services Python SDK.

### `adobe.pdfservices.operation.auth.credentials`

This module likely contains base classes or abstract definitions for credentials.

### `adobe.pdfservices.operation.auth.service_principal_credentials`

This module provides classes for managing credentials using a service principal.

*   **`ServicePrincipalCredentials`**: A class representing service principal credentials.
    *   `get_client_id()`: Retrieves the client ID.
    *   `get_client_secret()`: Retrieves the client secret.
```

--------------------------------

### ProtectPDFResult Asset Retrieval in Python

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices.operation

Shows how to get the protected PDF asset from the ProtectPDFResult object.

```Python
from adobe.pdfservices.operation.pdfjobs.result.protect_pdf_result import ProtectPDFResult

# Example usage:
protect_result = ProtectPDFResult()
asset = protect_result.get_asset()
```

--------------------------------

### Convert HTML to PDF using Adobe PDF Services Python SDK

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/pdfjobs/jobs

Demonstrates how to convert an HTML file or URL to a PDF document. It handles input as a local zip archive or a static HTML file with inline CSS, or via a URL. Requires specifying the input asset or URL and optional parameters for page layout and headers/footers.

```python
file = open('SOURCE_PATH', 'rb')
input_stream = file.read()
file.close()
credentials = ServicePrincipalCredentials(
    client_id=os.getenv('PDF_SERVICES_CLIENT_ID'),
    client_secret=os.getenv('PDF_SERVICES_CLIENT_SECRET')
)
pdf_services = PDFServices(credentials=credentials)
input_asset = pdf_services.upload(input_stream=input_stream, mime_type=MediaType.ZIP)
page_layout = PageLayout(page_height=11.5, page_width=8)
html_to_pdf_params =  HTMLtoPDFParams(page_layout=page_layout, include_header_footer=True)
html_to_pdf_job = HTMLtoPDFJob(input_asset=input_asset, html_to_pdf_params=html_to_pdf_params)
location = pdf_services.submit(html_to_pdf_job)
pdf_services_response = pdf_services.get_job_result(location, HTMLtoPDFResult)
result_asset: CloudAsset = pdf_services_response.get_result().get_asset()
stream_asset: StreamAsset = pdf_services.get_content(result_asset)
```

--------------------------------

### LinearizePDFResult Asset Retrieval in Python

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices.operation

Shows how to get the linearized PDF asset from the LinearizePDFResult object.

```Python
from adobe.pdfservices.operation.pdfjobs.result.linearize_pdf_result import LinearizePDFResult

# Example usage:
linearize_result = LinearizePDFResult()
asset = linearize_result.get_asset()
```

--------------------------------

### Adobe PDF Services Python SDK Methods

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

This section lists various methods available in the Adobe PDF Services Python SDK for different PDF operations.

```APIDOC
## Adobe PDF Services Python SDK Methods

### Description
This section provides a list of methods available within the Adobe PDF Services Python SDK. These methods cover a wide range of PDF processing tasks, including conversion, manipulation, and security.

### Methods

- **get_export_pdf_to_images_target_format()**: Method within `ExportPDFtoImagesParams` for specifying the target format when exporting PDF to images.
- **get_external_storage_type()**: Method within `ExternalAsset` for retrieving the type of external storage.
- **get_field_location()**: Method within `FieldOptions` for getting the location of a form field.
- **get_field_name()**: Method within `FieldOptions` for getting the name of a form field.
- **get_file_count()**: Method within `SplitPDFParams` for getting the number of files.
- **get_file_ext()**: Method within `ExportPDFTargetFormat` for getting the file extension.
- **get_file_path()**: Method within the `path_util` module for getting a file path.
- **get_format()**: Method within `OutputFormat` for getting the output format.
- **get_fragments()**: Method within `DocumentMergeParams` for retrieving fragments for document merging.
- **get_fragments_list()**: Method within `Fragments` for getting a list of fragments.
- **get_from_extension()**: Static method within `PDFServicesMediaType` for creating an object from a file extension.
- **get_generate_report()**: Method within `AutotagPDFParams` for generating a report.
- **get_header_info()**: Method within `OperationHeaderInfoEndpointMap` for retrieving header information.
- **get_host()**: Method within `ProxyServerConfig` for getting the proxy server host.
- **get_include_header_footer()**: Method within `HTMLtoPDFParams` for checking if header and footer are included.
- **get_include_page_level_properties()**: Method within `PDFPropertiesParams` for checking if page-level properties are included.
- **get_input_stream()**: Method within `StreamAsset` for getting the input stream.
- **get_job_result()**: Class method within `PDFServicesHelper` or method within `PDFServices` for retrieving job results.
- **get_job_status()**: Class method within `PDFServicesHelper` or method within `PDFServices` for retrieving job status.
- **get_json()**: Method within `HTMLtoPDFParams` for getting JSON data.
- **get_json_data_for_merge()**: Method within `DocumentMergeParams` for getting JSON data for merging.
- **get_json_form_fields_data()**: Method within `ImportPDFFormDataParams` for getting JSON form fields data.
- **get_json_form_fields_data_string()**: Method within `ImportPDFFormDataParams` for getting JSON form fields data as a string.
- **get_left()**: Method within `FieldLocation` for getting the left coordinate.
- **get_length()**: Method within `PageActions` for getting the length.
- **get_locale()**: Method within `OCRSupportedLocale` for getting the OCR locale.
- **get_message()**: Method within `JobErrorResponse` for getting the error message.
- **get_mime_type()**: Method within `StreamAsset` for getting the MIME type.
- **get_ocr_lang()**: Method within `ExportPDFParams` for getting the OCR language.
- **get_ocr_locale()**: Method within `OCRParams` for getting the OCR locale.
- **get_ocr_type()**: Method within `OCRParams` for getting the OCR type.
- **get_opacity()**: Method within `WatermarkAppearance` for getting the opacity.
- **get_output_format()**: Method within `DocumentMergeParams` for getting the output format.
- **get_output_type()**: Method within `ExportPDFToImagesOutputType` for getting the output type.
- **get_owner_password()**: Method within `PasswordProtectParams` for getting the owner password.
- **get_page_actions()**: Method within `RotatePagesParams` for getting page actions.
- **get_page_count()**: Method within `SplitPDFParams` for getting the page count.
```

--------------------------------

### ExportPDFtoImagesResult Asset Retrieval in Python

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices.operation

Shows how to get multiple image assets from the ExportPDFtoImagesResult object.

```Python
from adobe.pdfservices.operation.pdfjobs.result.export_pdf_to_images_result import ExportPDFtoImagesResult

# Example usage:
export_images_result = ExportPDFtoImagesResult()
assets = export_images_result.get_assets()
```

--------------------------------

### Client Configuration JSON Structure

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/config

Example JSON structure for client configuration, specifying connection timeout, read timeout, proxy server details including credentials, and the region.

```json
{
    "connectTimeout": "4000",
    "readTimeout": "20000",
    "proxyServerConfig": {
        "host": "127.0.0.1",
        "port": "8080",
        "scheme": "https",
        "usernamePasswordCredentials": {
            "username": "username",
            "password": "password"
            }
    },
    "region": "EU"
}
```

--------------------------------

### Create PDF Watermark Job Instance

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/pdfjobs/jobs

Demonstrates creating a PDFWatermarkJob instance with input, watermark, and parameters, submitting it to PDF Services, and retrieving the processed content.

```python
pdf_watermark_job = PDFWatermarkJob(input_asset=input_asset, watermark_asset=watermark_asset,
                             pdf_watermark_params=pdf_watermark_params)
location = pdf_services.submit(pdf_watermark_job)
pdf_services_response = pdf_services.get_job_result(location, PDFWatermarkResult)
pdf_watermark_result: CloudAsset = pdf_services_response.get_result().get_asset()
stream_asset: StreamAsset = pdf_services.get_content(pdf_watermark_result)
```

--------------------------------

### Get Field Visibility

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the visibility status of a field within a PDF form.

```APIDOC
## GET /api/fields/{fieldId}/visible

### Description
Checks and returns whether a specific form field in a PDF is currently visible or hidden.

### Method
GET

### Endpoint
`/api/fields/{fieldId}/visible`

### Parameters
#### Path Parameters
- **fieldId** (string) - Required - The unique identifier for the form field.

### Response
#### Success Response (200)
- **isVisible** (boolean) - True if the field is visible, false otherwise.

#### Response Example
```json
{
  "isVisible": false
}
```
```

--------------------------------

### Get Job Status Value

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/genindex

Retrieves the specific value representing the job status.

```APIDOC
## GET /api/jobs/status/value

### Description
Returns the current status indicator or value for a PDF processing job.

### Method
GET

### Endpoint
`/api/jobs/status/value`

### Response
#### Success Response (200)
- **jobStatusValue** (string) - The value representing the job's status (e.g., "SUCCESS", "FAILED", "IN_PROGRESS").

#### Response Example
```json
{
  "jobStatusValue": "SUCCESS"
}
```
```

--------------------------------

### ESealPDFResult Asset Retrieval in Python

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/adobe.pdfservices.operation

Illustrates fetching the e-sealed PDF asset using the ESealPDFResult object.

```Python
from adobe.pdfservices.operation.pdfjobs.result.eseal_pdf_result import ESealPDFResult

# Example usage:
eseal_result = ESealPDFResult()
asset = eseal_result.get_asset()
```

--------------------------------

### NotifierConfig Class Initialization (Python)

Source: https://opensource.adobe.com/pdfservices-python-sdk-samples/apidocs/latest/reference/config/notifier

Demonstrates the creation of the NotifierConfig class, used to configure notifications for PDF Services job completion. It requires a NotifierType and NotifierData.

```python
from adobe.pdfservices.operation.config.notifier.notifier_config import NotifierConfig
from adobe.pdfservices.operation.config.notifier.notifier_type import NotifierType
from adobe.pdfservices.operation.config.notifier.callback_notifier_data import CallbackNotifierData

# Assuming callback_notifier_data is already created as shown above

notifier_config = NotifierConfig(notifier_type=NotifierType.CALLBACK, notifier_data=callback_notifier_data)
```
Tokens:
Raw