Authentication

Looking for usage documentation? Check out Classification and Regression.

`init`

Initializes the TabPFN client and authenticates with the TabPFN cloud service. Authentication is token-based and never interactive. The token comes from set_access_token() or the TABPFN_TOKEN environment variable, or from a token cached by an earlier interactive_login(). If none is available this raises, explaining how to obtain one — it will not prompt. Generate a token at https://platform.priorlabs.ai/account/api-keys, or call tabpfn_client.interactive_login() to log in through the browser.

init(
    use_server: bool = True,
)

Parameters

Parameter	Type	Default	Description
`use_server`	`bool`	`True`	Whether to use the TabPFN cloud service. Currently, only `True` is supported.

Raises RuntimeError If local inference is requested, if the server is unreachable, or if no valid access token is available.

View source

Log in or create an account interactively, returning the access token. This is opt-in. The default authentication path never calls it: init() uses TABPFN_TOKEN, set_access_token(), or a cached token, and raises with instructions when none is available. Offers two routes. Logging in opens the Prior Labs login page in a browser (or prints the URL when there is no display) and waits for the resulting API key. Creating an account runs entirely in the terminal, which is what makes this usable from a hosted notebook where a browser tab is not an option. On success the token is verified, cached for future runs, and installed as the active token, so a subsequent init() needs no further input.

interactive_login(
    *,
    force_relogin: bool = False,
    open_browser: bool = True,
    timeout: float = _CALLBACK_TIMEOUT_SECS,
) -> str

Parameters

Parameter	Type	Default	Description
`force_relogin`	`bool`	`False`	Run the login flow even when a working token is already available, for example to switch accounts. By default an existing token is returned as-is.
`open_browser`	`bool`	`True`	Open the login page in a browser. When `False` (or when no display is detected) the URL is printed and you paste the API key instead. Does not affect signup, which never needs a browser.
`timeout`	`float`	`_CALLBACK_TIMEOUT_SECS`	Seconds to wait for the browser callback. The paste prompt stays available throughout.

Returns

Type	Description
`str`	The access token.

Raises InteractiveLoginError If no terminal is available, the flow was aborted, or the resulting token was rejected.

`get_access_token`

View source

Retrieves the current active access token. If the client is not yet initialized, this will trigger the init() login flow.

get_access_token() -> str

Returns

Type	Description
`str`	The access token string used for API requests.

Raises RuntimeError If no access token is available after initialization.

`set_access_token`

View source

Manually sets the access token for the session. Use this in non-interactive environments (e.g. CI/CD, notebooks) as an alternative to the TABPFN_TOKEN environment variable. Generate a token at https://platform.priorlabs.ai/account/api-keys

set_access_token(
    access_token: str,
)

Parameters

Parameter	Type	Default	Description
`access_token`	`str`	Required	A valid TabPFN access token string.

`reset`

View source

Resets the client state and clears local authentication caches. Use this function if you need to log out or clear stored session data from the local machine.

reset()

Reference

tabpfn

tabpfn-client

tabpfn-extensions

REST API

`init`

`get_access_token`

`set_access_token`

`reset`

​init

​interactive_login

​get_access_token

​set_access_token

​reset

`init`

`interactive_login`

`get_access_token`

`set_access_token`

`reset`