unstract-client 1.5.1

Python client for the Unstract LLM-powered structured data extraction platform

unstract-python-client

Python client for the Unstract LLM-powered structured data extraction platform

Installation

You can install the Unstract Python Client using pip:

pip install unstract-client

Usage

First, import the APIDeploymentsClient from the client module:

from unstract.api_deployments.client import APIDeploymentsClient

Then, create an instance of the APIDeploymentsClient:

client = APIDeploymentsClient(api_url="url", api_key="your_api_key")

Note: Pass the raw API key without the "Bearer " prefix — the client adds it automatically.

Now, you can use the client to interact with the Unstract API deployments API:

try:
    adc = APIDeploymentsClient(
        api_url=os.getenv("UNSTRACT_API_URL"),
        api_key=os.getenv("UNSTRACT_API_DEPLOYMENT_KEY"),
        api_timeout=10,
        logging_level="DEBUG",
        include_metadata=False # optional
    )
    # Replace files with pdfs
    response = adc.structure_file(
        ["<files>"]
    )
    print(response)
    if response["pending"]:
        while True:
            p_response = adc.check_execution_status(
                response["status_check_api_endpoint"]
            )
            print(p_response)
            if not p_response["pending"]:
                break
            print("Sleeping and checking again in 5 seconds..")
            time.sleep(5)
except APIDeploymentsClientException as e:
    print(e)

Parameter Details

api_url: The URL of the Unstract API deployment. api_key: Your raw API key. Do not include the "Bearer " prefix — the client adds it automatically. api_timeout: Set a timeout for API requests, e.g., api_timeout=10. logging_level: Set logging verbosity (e.g., "DEBUG"). include_metadata: If set to True, the response will include additional metadata (cost, tokens consumed and context) for each call made by the Prompt Studio exported tool.

Retry Configuration

The client includes built-in exponential backoff retry with the following behavior:

• Async mode (api_timeout=0): POST requests are retried on transient failures (5xx, 429) and connection errors, since the server returns immediately after queuing.
• Sync mode (api_timeout > 0, the default): POST requests are not retried, because the server blocks during processing — a failure may mean the request was processed but the response was lost.
• Status polling (check_execution_status): GET requests are always retried, as they are idempotent.

Retries are enabled by default and can be customized:

client = APIDeploymentsClient(
    api_url="url",
    api_key="your_api_key",
    max_retries=4,       # Max retry attempts (default: 4, set to 0 to disable)
    initial_delay=2.0,   # Initial delay in seconds (default: 2.0)
    max_delay=60.0,      # Maximum delay cap in seconds (default: 60.0)
    backoff_factor=2.0,  # Multiplier per retry (default: 2.0)
)

Parameter	Default	Description
max_retries	4	Maximum number of retry attempts. Set to 0 to disable retries.
initial_delay	2.0	Initial delay in seconds before the first retry.
max_delay	60.0	Maximum delay cap in seconds between retries.
backoff_factor	2.0	Multiplier applied to the delay for each subsequent retry.

The retry logic uses exponential backoff with full jitter and respects the Retry-After header on 429 responses.

Unstract CLI

Installing unstract-client also provides the unstract command:

pip install unstract-client
unstract --help

unstract clone

Clones an organization's resources to another org, on the same or a different deployment (e.g. promote dev → QA → prod). Covers adapters, connectors, workflows, pipelines, API deployments, Prompt Studio projects and their files, user groups, and sharing state (users matched by email, groups by name).

Authenticates with each org admin's Platform API key; prefer the env vars so keys never land in shell history:

export UNSTRACT_SRC_PLATFORM_KEY="<source platform key>"
export UNSTRACT_TGT_PLATFORM_KEY="<target platform key>"

unstract clone \
  --source-url https://dev.example.com --source-org org_dev123 \
  --target-url https://qa.example.com --target-org org_qa456 \
  --dry-run

Drop --dry-run to perform the clone.

Option	Description
--dry-run	Plan only; nothing is written.
--include / --exclude	Comma-separated phases to run / skip.
--on-name-conflict	adopt (default) reuses like-named target resources; abort stops.
--clone-group-members	Also add group members on target, matched by email.
--source-key / --target-key	Platform API keys, if not set via env vars.
--api-prefix	Backend URL prefix (default api/v1).

Re-runs are idempotent: existing target resources are adopted by name, so a failed run can be resumed by re-running the same command.

Exit code	Meaning
0	Success.
1	Completed with failures — see the printed report.
2	Could not run (setup error or --on-name-conflict=abort collision).

Compatibility

unstract clone is capability-probed: each phase checks for its endpoint on the source and target, and clones only what both orgs support. A capability missing on either side is reported and skipped — the run never fails because of a version difference. Cloning a newer source into an older target therefore drops the entity types the target lacks (listed in the end-of-run report).

• Run the source and target on the same (or a newer-target) Unstract build.
• Use unstract-client >= 1.4.0, the first release that ships unstract clone.

Questions and Feedback

On Slack, join great conversations around LLMs, their ecosystem and leveraging them to automate the previously unautomatable!

Unstract Cloud: Signup and Try!

Unstract developer documentation: Learn more about Unstract and its API.