Remaining Credits API

tabpfn_client/__init__.py

@@ -1,7 +1,13 @@
 #  Copyright (c) Prior Labs GmbH 2025.
 #  Licensed under the Apache License, Version 2.0
 
-from tabpfn_client.config import init, reset, get_access_token, set_access_token
+from tabpfn_client.config import (
+    init,
+    reset,
+    get_access_token,
+    set_access_token,
+    get_api_usage,
+)
 from tabpfn_client.estimator import TabPFNClassifier, TabPFNRegressor
 from tabpfn_client.service_wrapper import UserDataClient
 
@@ -13,4 +19,5 @@
     "UserDataClient",
     "get_access_token",
     "set_access_token",
+    "get_api_usage",
 ]

tabpfn_client/client.py

@@ -855,3 +855,19 @@ def try_browser_login(cls) -> tuple[bool, str]:
             return True, token
 
         return False, "Browser login failed or was cancelled"
+
+    @classmethod
+    def get_api_usage(cls, access_token: str):
+        """
+        Retrieve current API usage data of the user from the server.
+        Returns summary: str
+        """
+        response = cls.httpx_client.post(
+            cls.server_endpoints.get_api_usage.path,
+            headers={"Authorization": f"Bearer {access_token}"},
+        )
+        cls._validate_response(response, "get_api_usage")
+
+        response = response.json()
+
+        return f"Currently, you have used {response['current_usage']} of the allowed limit of {'Unlimited' if int(response['usage_limit']) == -1 else response['usage_limit']} credits. The limit will reset at {response['reset_time']}."

tabpfn_client/config.py

@@ -81,3 +81,8 @@ def get_access_token() -> str:
 def set_access_token(access_token: str):
     UserAuthenticationClient.set_token(access_token)
     Config.is_initialized = True
+
+
+def get_api_usage() -> dict:
+    access_token = get_access_token()
+    return ServiceClient.get_api_usage(access_token)

tabpfn_client/server_config.yaml

@@ -109,3 +109,8 @@ endpoints:
     methods: [ "DELETE" ]
     description: "Delete user account, alongside all associated data"
 
+  get_api_usage:
+    path: "/get_api_usage/"
+    methods: [ "POST" ]
+    description: "Get prediction hits data for a given user"
+