pypi / apify-client

apify-client

What changed in apify-client 3, from its official release notes, upgrade guides and advisories. Sources checked 2026-10-31.

4 breaking12 new APIs and options2 behavior and defaults12 fixes and other

See which of these apply to your code, ranked, in your agent:

npx @unstale/cli init

apify-client 330 changes

Rental pricing fields were removed from CurrentPricingInfo.
3.4.0release notes
The client requires impit>=0.15.1 to drop the compromised emSign CA.
3.4.0release notes
Unparsable response bodies now consistently raise InvalidResponseBodyError.
3.3.0release notes
The validate_input() parameter was renamed from build_tag to build.
3.3.0release notes

The charge() method accepts X-Actor-Request-ID.
3.4.0release notes
New error types were added.
3.4.0release notes
Collection iterate() methods accept chunk_size.
3.4.0release notes
Resource clients now support additional optional parameters.
3.4.0release notes
A user_agent_suffix option is available for customizing the user agent.
3.4.0release notes
Task call() now accepts max_total_charge_usd.
3.3.0release notes
Actor creation and update now support default_run_force_permission_level.
3.3.0release notes
Run dataset items can now be iterated over live.
3.3.0release notes
Missing Standby fields are now available when creating and updating Actors.
3.3.0release notes
Task start() now accepts max_total_charge_usd.
3.3.0release notes
Dataset stream_items now accepts flatten.
3.3.0release notes
Request bodies can now be streamed from files, iterables, and responses.
3.3.0release notes

The default gzip compression quality is now 6.
3.3.0release notes
Starting a run is retried when memory or concurrent-runs limits are reached.
3.3.0release notes

Missing fields were added to the Actor definition model.
3.4.0release notes
The client appends /v2 to api_url only when it is missing.
3.4.0release notes
On last_run() clients, get_streamed_log() fetches the Actor from the API root.
3.4.0release notes
Setting max_retries to 0 now disables retries.
3.4.0release notes
The client now supports Python 3.15.
3.4.0release notes
The run log is redirected when the first log stream is empty.
3.4.0release notes
example_run_input_body is now typed as str.
3.3.0release notes
Model names now align with the renamed OpenAPI schemas.
3.3.0release notes
The Profile model now includes the previously missing readme field.
3.3.0release notes
A failing background watcher no longer breaks a successful Actor call.
3.2.1release notes
Dataset iterators no longer skip items when unwind is used.
3.2.1release notes
The JsonSerializable type alias is read-only.
3.2.1release notes