> ## Documentation Index
> Fetch the complete documentation index at: https://docs.priorlabs.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> TabPFN-3 and later versions support up to 1,000,000 rows, subject to feature count and checkpoint/API limits.
> For large datasets, use per-estimator subsampling, e.g. inference_config={"SUBSAMPLE_SAMPLES": 100_000}, in TabPFNClassifier or TabPFNRegressor from tabpfn or tabpfn_client.
> Pass raw pandas DataFrames to fit and predict. Categorical strings/categories, raw text, and missing feature values are handled automatically; no manual integer/one-hot encoding, imputation, scaling, or outlier removal is needed.

# Configuration

> Configure client requests, fit modes, model versions, and environment settings.

<Info>
  Looking for usage documentation? Check out [Classification](/capabilities/classification), [Regression](/capabilities/regression) and [KV cache](/capabilities/kv-cache).
</Info>

<div className="python-reference-heading">
  <h2 id="clientoptions">
    `ClientOptions`
  </h2>

  <a className="python-reference-source" href="https://github.com/PriorLabs/tabpfn-client/blob/5f8aee56ad2a788458704c342347e9bc282cebe9/src/tabpfn_client/models.py#L63" aria-label="View source for ClientOptions"><span aria-hidden="true">\</></span> View source <span aria-hidden="true">↗</span></a>
</div>

Options for the client.

Can be used to override default client behavior for a single request.

```python theme={null}
ClientOptions(
    timeout: float = get_opts().TABPFN_CLIENT_TIMEOUT,
    headers: dict[str, str] = dict(),
)
```

**Fields**

<div className="python-reference-table">
  | Name | Type | Default | Description |
  | - | - | - | - |
  | <span id="clientoptions-timeout" /><code className="python-reference-parameter">timeout</code> | <code className="python-reference-type">float</code> | `get_opts().TABPFN_CLIENT_TIMEOUT` | Timeout for the request in seconds. |
  | <span id="clientoptions-headers" /><code className="python-reference-parameter">headers</code> | <code className="python-reference-type">dict\[str, str]</code> | `dict()` | Headers for the request overriding the default headers. |
</div>

***

<div className="python-reference-heading">
  <h2 id="apimode">
    `ApiMode`
  </h2>

  <a className="python-reference-source" href="https://github.com/PriorLabs/tabpfn-client/blob/5f8aee56ad2a788458704c342347e9bc282cebe9/src/tabpfn_client/models.py#L22" aria-label="View source for ApiMode"><span aria-hidden="true">\</></span> View source <span aria-hidden="true">↗</span></a>
</div>

Server API mode: synchronous, asynchronous, or chosen by the client.

**Fields**

<div className="python-reference-table">
  | Name | Type | Default | Description |
  | - | - | - | - |
  | <span id="apimode-auto" /><code className="python-reference-parameter">AUTO</code> | — | `"auto"` | — |
  | <span id="apimode-sync" /><code className="python-reference-parameter">SYNC</code> | — | `"sync"` | — |
  | <span id="apimode-async" /><code className="python-reference-parameter">ASYNC</code> | — | `"async"` | — |
</div>

***

<div className="python-reference-heading">
  <h2 id="modelversion">
    `ModelVersion`
  </h2>

  <a className="python-reference-source" href="https://github.com/PriorLabs/tabpfn-client/blob/5f8aee56ad2a788458704c342347e9bc282cebe9/src/tabpfn_client/api_models.py#L132" aria-label="View source for ModelVersion"><span aria-hidden="true">\</></span> View source <span aria-hidden="true">↗</span></a>
</div>

***

<div className="python-reference-heading">
  <h2 id="fitmodeliteral">
    `FitModeLiteral`
  </h2>

  <a className="python-reference-source" href="https://github.com/PriorLabs/tabpfn-client/blob/5f8aee56ad2a788458704c342347e9bc282cebe9/src/tabpfn_client/models.py#L19" aria-label="View source for FitModeLiteral"><span aria-hidden="true">\</></span> View source <span aria-hidden="true">↗</span></a>
</div>

***

<div className="python-reference-heading">
  <h2 id="thinkingeffort">
    `ThinkingEffort`
  </h2>

  <a className="python-reference-source" href="https://github.com/PriorLabs/tabpfn-client/blob/5f8aee56ad2a788458704c342347e9bc282cebe9/src/tabpfn_client/api_models.py#L53" aria-label="View source for ThinkingEffort"><span aria-hidden="true">\</></span> View source <span aria-hidden="true">↗</span></a>
</div>

***

<div className="python-reference-heading">
  <h2 id="texthandling">
    `TextHandling`
  </h2>

  <a className="python-reference-source" href="https://github.com/PriorLabs/tabpfn-client/blob/5f8aee56ad2a788458704c342347e9bc282cebe9/src/tabpfn_client/api_models.py#L50" aria-label="View source for TextHandling"><span aria-hidden="true">\</></span> View source <span aria-hidden="true">↗</span></a>
</div>

***

<div className="python-reference-heading">
  <h2 id="options">
    `Options`
  </h2>

  <a className="python-reference-source" href="https://github.com/PriorLabs/tabpfn-client/blob/5f8aee56ad2a788458704c342347e9bc282cebe9/src/tabpfn_client/options.py#L9" aria-label="View source for Options"><span aria-hidden="true">\</></span> View source <span aria-hidden="true">↗</span></a>
</div>

Client settings, each overridable by the environment variable of the same name.

**Fields**

<div className="python-reference-table">
  | Name | Type | Default | Description |
  | - | - | - | - |
  | <span id="options-tabpfn-token" /><code className="python-reference-parameter">TABPFN\_<wbr />TOKEN</code> | <code className="python-reference-type">str \| None</code> | `None` | Access token used for authentication. |
  | <span id="options-tabpfn-client-api-url" /><code className="python-reference-parameter">TABPFN\_<wbr />CLIENT\_<wbr />API\_<wbr />URL</code> | <code className="python-reference-type">str \| None</code> | `None` | Override for the server URL. |
  | <span id="options-tabpfn-client-max-thread-per-upload" /><code className="python-reference-parameter">TABPFN\_<wbr />CLIENT\_<wbr />MAX\_<wbr />THREAD\_<wbr />PER\_<wbr />UPLOAD</code> | <code className="python-reference-type">int</code> | `8` | Maximum threads used per upload. |
  | <span id="options-tabpfn-client-timeout" /><code className="python-reference-parameter">TABPFN\_<wbr />CLIENT\_<wbr />TIMEOUT</code> | <code className="python-reference-type">float</code> | `900.0` | Default request timeout in seconds. |
  | <span id="options-tabpfn-client-upload-timeout" /><code className="python-reference-parameter">TABPFN\_<wbr />CLIENT\_<wbr />UPLOAD\_<wbr />TIMEOUT</code> | <code className="python-reference-type">float</code> | `7200.0` | Upload timeout in seconds. |
  | <span id="options-tabpfn-client-force-reupload" /><code className="python-reference-parameter">TABPFN\_<wbr />CLIENT\_<wbr />FORCE\_<wbr />REUPLOAD</code> | <code className="python-reference-type">bool</code> | `False` | Whether to re-upload datasets the server already holds. |
  | <span id="options-tabpfn-client-dedup-datasets" /><code className="python-reference-parameter">TABPFN\_<wbr />CLIENT\_<wbr />DEDUP\_<wbr />DATASETS</code> | <code className="python-reference-type">bool</code> | `True` | Whether to deduplicate dataset uploads. |
  | <span id="options-tabpfn-client-async-use-above-trainset-size" /><code className="python-reference-parameter">TABPFN\_<wbr />CLIENT\_<wbr />ASYNC\_<wbr />USE\_<wbr />ABOVE\_<wbr />TRAINSET\_<wbr />SIZE</code> | <code className="python-reference-type">int</code> | `50 * 1024 * 1024` | Train-set size in bytes above which the asynchronous API is used. Overridden by the server default unless set in the environment. |
  | <span id="options-tabpfn-client-async-poll-timeout" /><code className="python-reference-parameter">TABPFN\_<wbr />CLIENT\_<wbr />ASYNC\_<wbr />POLL\_<wbr />TIMEOUT</code> | <code className="python-reference-type">float</code> | `7200.0` | Timeout in seconds when polling an asynchronous job. Overridden by the server default unless set in the environment. |
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.