Metadata-Version: 2.4
Name: apivault-ai-background-changer
Version: 0.1.0
Summary: Python client for AI Background Changer on Apify. Run, resume and download results with diagnostics.
Author: ApiVault Labs
License-Expression: MIT
Project-URL: Homepage, https://apify.com/apivault_labs/aI-background-changer
Project-URL: Source, https://github.com/apivault-labs/apivault-labs/tree/main/python-clients/apivault-ai-background-changer
Project-URL: Documentation, https://github.com/apivault-labs/apivault-labs/tree/main/python-clients/apivault-ai-background-changer#readme
Keywords: apify,python-sdk,ai,background,changer
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# AI Background Changer — Python client

Replace photo backgrounds from text prompts; process uploaded files, URLs or storage images. Bulk result-link export: JSON, CSV, Excel and API. PPE: $7/1K delivered photos; start fee, usage extra.

This client starts the hosted [Apify Actor](https://apify.com/apivault_labs/aI-background-changer), waits for completion and downloads Dataset records. It also reads SUMMARY and ERRORS when available. Source coverage and result fields depend on the Actor.

## Install

```bash
pip install apivault-ai-background-changer
```

## Run

Set `APIFY_TOKEN` in your environment. Replace the example values with your own valid inputs from the [Actor input form](https://apify.com/apivault_labs/aI-background-changer/input).

```python
from apivault_ai_background_changer import Client, WaitTimeout

client = Client()
actor_input = {
    "imageUrls": [
        "REPLACE_WITH_YOUR_INPUT"
    ]
}
result = client.run(actor_input, max_total_charge_usd=0.05, max_rows=100)
print(result.run_id, len(result.rows), result.truncated)
print(result.summary)
```

An Apify account and token are required. The package has no subscription of its own; hosted runs are billed by Apify under the Actor pricing. The event charge cap may not include platform usage. Review the [current price](https://apify.com/apivault_labs/aI-background-changer/pricing) before changing it. `max_rows` limits the download, not the Actor collection or its charges; configure an Actor result limit too.

## Resume and diagnostics

`client.start(input)` returns a run ID; `client.wait(run_id)` and `client.result(run_id)` resume an existing run. A `WaitTimeout` exposes `run_id`. Starting a run is never automatically retried. Use an existing run ID after a connection or waiting failure to avoid duplicate paid runs. Failed and aborted runs raise `ActorError`. No-match and partial results require inspecting `summary` and `errors`; diagnostic rows must not be mistaken for useful results.

Rows can be serialized as JSON or used in your own CSV/Excel pipeline. Native Dataset exports are available in Apify. Optional integrations and credentials depend on the Actor.

[Hosted Actor](https://apify.com/apivault_labs/aI-background-changer) · [Source](https://github.com/apivault-labs/apivault-labs/tree/main/python-clients/apivault-ai-background-changer) · [PyPI](https://pypi.org/project/apivault-ai-background-changer/)
