Skip to main content
Applicable to: Anyone who installs the truefoundry Python package (CLI, SDK, experiment tracking, tfy apply in CI, or a pinned version in a job or notebook image), the truefoundry-sdk package in Python or TypeScript, or anyone who calls the Repositories APIs from custom code.Not applicable if you never install these packages and never call the Repositories APIs from custom code.

What Is Changing

Two things are changing together:
  1. The Repositories APIs now use the /api/svc prefix instead of /api/ml.
  2. Older truefoundry and truefoundry-sdk package versions that still call /api/ml are deprecated.
The APIs themselves are not going away. Only the old prefix and the old package versions are.

1. Repositories APIs move from /api/ml to /api/svc

The Repositories APIs are the HTTP APIs for: These APIs now live under /api/svc. HTTP method, query parameters, and request/response bodies are unchanged. Nested paths (/*) move the same way. Example:
  • On control plane 0.157.x and later, /api/ml is deprecated. Use /api/svc.
  • On control plane 0.188.x, /api/ml is removed. Calls to that prefix fail.
If you call these HTTP paths from your own code (scripts, services, or GitOps), search for /api/ml/ and change the prefix. If you only use truefoundry or truefoundry-sdk, upgrade the package instead — you do not need to edit URLs by hand.

2. Older truefoundry and truefoundry-sdk versions are deprecated

truefoundry 0.17.x and truefoundry-sdk 0.4.x already call /api/svc. Older package versions still call /api/ml. Those versions are deprecated:
  • On control plane < 0.157.x, truefoundry < 0.16.0 and truefoundry-sdk < 0.3.0 are deprecated.
  • On control plane 0.157.x and later, truefoundry < 0.17.0 and truefoundry-sdk < 0.4.0 are deprecated.
  • On control plane 0.188.x, requests from older truefoundry versions ( < 0.17.0 ) are rejected.
truefoundry 0.17.x requires Python 3.10 or later. See Minimum Python version raised to 3.10 — truefoundry v0.17.0.v0.17.0 also removes run.log_images() and run.log_plots(). Migrate those calls before upgrading: Deprecation of Images and Plots in Job Runs — v0.156.0.

When this becomes a hard break

Requests from outdated truefoundry Python packages will be rejected only when your tenant reaches control plane 0.188.x. You will receive the following error message:
Calls that still use /api/ml fail because that prefix is removed. SaaS is expected to reach 0.188.x around 15 November 2026. Self-hosted tenants are unaffected until they upgrade to 0.188.x.

Which version should I install?

The package version you need depends on your control plane version. Find it at the top left, below the logo.
SaaS: Your control plane is already on latest version. Install truefoundry>=0.17.0 and truefoundry-sdk>=0.4.0 now.
Do not install truefoundry 0.17.x or truefoundry-sdk 0.4.x on a control plane older than 0.157.x.

What You Need to Do

1

Upgrade Python to 3.10 or later

Required before installing truefoundry 0.17.x. See Minimum Python version raised to 3.10.
2

Upgrade the truefoundry package

3

Upgrade truefoundry-sdk (if you use it)

truefoundry-sdk is published for both Python and TypeScript:
4

Repeat everywhere the packages are pinned

Update laptops, CI (tfy apply and GitHub Actions), requirements.txt / lockfiles, and job or notebook images.
5

Update custom HTTP clients

If you call the Repositories APIs from your own code, change /api/ml to /api/svc. See the table in What Is Changing.
Upgrade to truefoundry>=0.17.0 (Python 3.10+) and truefoundry-sdk>=0.4.0 before your control plane reaches 0.188.x. After that version, older Python packages and /api/ml calls will fail.

If you have questions or need help choosing a version, reach out to support@truefoundry.com — we’re happy to assist.