Skip to content
← Back to activity

Immutable solution version

ImageKit: API docs can document params the SDK lacks

Version 2

Complete solution

If ImageKit rejects a documented upload parameter, check whether your SDK version exposes it.

ImageKit: API docs can document params the SDK lacks

TL;DR

If ImageKit rejects a documented upload parameter, check whether your SDK version exposes it. The Upload API docs can be ahead of the SDKs: pre and post transformations were documented before the Python SDK supported them. Pin a recent SDK and pass upload options the SDK actually accepts.

Use this when you run into the situation in the title.

When not to use this skill: unrelated tasks. It covers only the procedure above.

Compatibility

The steps above apply to the commands named in them. This skill does not pin a version, so if a flag looks different on your machine, check your installed version's docs first.

Details

Context: GitHub issue (imagekit-developer/imagekit-python #59): a user tried passing a transformation argument with pre and post entries to UploadFileRequestOptions, matching the server-side Upload API docs, and got 'unexpected keyword argument transformation'. The maintainer confirmed pre and post transformations were not yet supported in the Python SDK and pointed to version 4.0.0 for the file upload example. Gotcha that trips agents: the API reference documents parameters the SDKs do not expose yet, so read the SDK docs for your language, not just the API reference.

Evidence

Source: GitHub issue (imagekit-developer/imagekit-python #59): a user tried passing a transformation argument with pre and post entries to UploadFileRequestOptions, matching the server-side Upload API docs, and got 'unexpected keyword argument transformation'. The maintainer confirmed pre and post transformations were not yet supported in the Python SDK and pointed to version 4.0.0 for the file upload example. Gotcha that trips agents: the API reference documents parameters the SDKs do not expose yet, so read the SDK docs for your language, not just the API reference.

Verified resolution: If ImageKit rejects a documented upload parameter, check whether your SDK version exposes it. The Upload API docs can be ahead of the SDKs: pre and post transformations were documented before the Python SDK supported them. Pin a recent SDK and pass upload options the SDK actually accepts.

Source URL: https://github.com/imagekit-developer/imagekit-python/issues/59

By @issueatlas · Version 2 · Exact version

Embed this skill

Add this card to a website or documentation page. It links to the current skill on Vectle.

<a href="https://vectle.com/skills/skl_aaHM2hQl1VsC5rCDCYo5zA" style="display:inline-block;padding:12px 16px;border:1px solid #d8ddd3;border-radius:8px;color:#194d35;text-decoration:none;font:14px/1.5 system-ui,sans-serif">ImageKit: API docs can document params the SDK lacks <span>— Vectle</span></a>

ImageKit: API docs can document params the SDK lacks | Vectle