Repository navigation
3.0.0-rc.0
Pre-release
Pre-release
3.0.0-rc.0 (2026-10-12)
This is the first release candidate of apify-client v3. It's published under the rc dist-tag, and latest stays on 2.x:
npm install apify-client@rcv3 has a lot of breaking changes, so read the upgrading guide before you switch. If something breaks, please open an issue.
🚀 Features
- [breaking] Generate all output models from the OpenAPI spec (#985) (cc054bf) by @vdusek
- [breaking] Validate API responses with zod schemas generated from the OpenAPI spec (#1016) (118f359) by @vdusek
- [breaking] Add ApifyApiError subclasses grouped by HTTP status (#1041) (e9ff0eb) by @vdusek
- [breaking] Normalize URL fields in responses (#1045) (39bdf71) by @vdusek
- [breaking] Expose the timeout tiers on the public API (#1046) (e50bf2e) by @vdusek
- [breaking] Make the client's own code runtime-independent (#1052) (511191e) by @vdusek
- [breaking] Make request-body compression configurable (#1065) (7878800) by @vdusek
- [breaking] Allow passing a custom HTTP client to ApifyClient (#1058) (ac2fe94) by @vdusek
- Accept an AbortSignal in resource-client methods (#1081) (eba2a21) by @vdusek
- Accept the /v2 API version path in baseUrl and publicBaseUrl (#1077) (a7be6fe) by @vdusek
- Allow
formatparameter indataset.createItemsPublicUrl(#1100) (bcf5cf5) by @gullmar - [breaking] Type Actor input as plain objects, arrays of them, or raw bytes (#1099) (6f4eb0e) by @vdusek
- Add live iteration over a run's dataset items (#1085) (f3ab011) by @vdusek
- Retry starting a run on memory and concurrent-runs limits (#1091) (d7c70ca) by @vdusek
- Add
pricingInfosandexampleRunInputtoActorUpdateOptions(#1144) (f62ab4a) by @vdusek
🐛 Bug Fixes
- Prevent path traversal by sanitizing URLs (#1011) (1967561) by @barjin
- [breaking] Correct Actor version, enum and setRecord input types (#1049) (b7b98c4) by @vdusek
- [breaking] Throw on ambiguous 404s instead of resolving to undefined (#1042) (58d18f2) by @vdusek
- [breaking] Type the Actor run input on ActorClient and RunClient (#1040) (a7ce30c) by @vdusek
- [breaking] Bump proxy-agent to v8 to remove the url.parse() deprecation warning (#1050) (0a73a63) by @vdusek
- [breaking] Keep pagination iterators advancing past fully filtered pages (#1044) (ac7dd23) by @vdusek
- [breaking] Convert date fields through the zod schemas instead of the *At suffix heuristic (#1060) (61d07b0) by @vdusek
- Carry the API error body of a failed streaming request (#1055) (ba48ad4) by @vdusek
- [breaking] Narrow
pushItems()to the item shapes the API actually accepts (#1066) (5aabe54) by @barjin - Add missing
readmefield toProfilemodel (#1110) (d530997) by @apify-service-account - Page offset iterators past the first page's total (#1125) (9cd54be) by @vdusek
- Bound StreamedLog.stop() when the log stream is quiet (#1123) (762d34c) by @vdusek
- Stop waitForFinish() polling a job that keeps returning 404 (#1124) (510823e) by @vdusek
- Redirect the run log when the first log stream comes back empty (#1105) (b79b5e5) by @vdusek
🚜 Refactor
- [breaking] Validate arguments with zod instead of ow (#986) (b8fafd9) by @vdusek
- [breaking] Convert to native ESM (#1015) (589a3a7) by @vdusek
- [breaking] Remove all deprecated options (#1039) (d4545d2) by @vdusek
- [breaking] Drop the underscore prefix from non-public members (#1059) (160fdb2) by @vdusek
- [breaking] Drop deprecated top-level restartOnError from ActorUpdateOptions (#1122) (0ba2a7e) by @vdusek
- [breaking] Narrow dataset unwind option to string[] (#1121) (5a379c3) by @vdusek
- [breaking] Align model names with the OpenAPI schemas (#1107) (1bb919d) by @vdusek
⚡ Performance
- Skip request-body compression for already-compressed content types (#1053) (c709586) by @vdusek
- [breaking] Serialize requests once in batchAddRequests (#1051) (bddfd7f) by @vdusek