---
title: "FormVlmConnectionSettings"
canonical_url: "https://www.nutrient.io/api/python/settings/vision/advanced/form-vlm-connection-settings/"
md_url: "https://www.nutrient.io/api/python/settings/vision/advanced/form-vlm-connection-settings.md"
last_updated: "2026-10-26T16:51:00.819Z"
description: "Settings for FormVlmConnection. Values fall back through three levels: document → SDK → built-in default."
---

Settings for FormVlmConnection. Values fall back through three levels: document → SDK → built-in default. Writes target the document only when set on a document's settings, otherwise the SDK globally when set on SdkSettings.

**Tags:** `Vision`, `Advanced`

```python

from nutrient_sdk import FormVlmConnectionSettings

```

## Construction

`FormVlmConnectionSettings` is accessed through a [`Document`](/api/python/document/) instance for per-document overrides, or via [`SdkSettings`](/api/python/settings/document/sdk-settings/) for SDK-wide defaults.

```python

# Per-document override

with Document.open("input.pdf") as doc:
    settings = doc.settings.form_vlm_connection_settings
    settings.some_field = new_value          # mutate fields directly

# SDK-wide default (applies to all documents)

SdkSettings.form_vlm_connection_settings.some_field = new_value

```

Settings are configured by writing to fields on the returned object. The settings property itself cannot be reassigned — `doc.settings.form_vlm_connection_settings = other_settings` is rejected.

## Properties

### api_endpoint

```python

@property
def api_endpoint(self) -> str

@api_endpoint.setter
def api_endpoint(self, value: str) -> None

```

API endpoint URL for the dedicated form-field model's OpenAI-compatible chat completions route. Empty (the default) until an operator configures it.

**Type:** `str`

**Default:** `string.Empty`

---

### api_key

```python

@property
def api_key(self) -> str

@api_key.setter
def api_key(self, value: str) -> None

```

API key for authentication with the dedicated form-field model service.

**Type:** `str`

**Default:** `string.Empty`

---

### model

```python

@property
def model(self) -> str

@model.setter
def model(self, value: str) -> None

```

Model identifier to request at the configured endpoint.

**Type:** `str`

**Default:** `"form-field-vlm"`

---

---

## Related pages

- [Advanced](/api/python/settings/vision/advanced.md)
- [Per-document override](/api/python/settings/vision/advanced/ai-augmenter-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/ai-processing-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/anthropic-api-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/claude-api-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/content-extraction-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/custom-vlm-api-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/deskew-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/document-layout-json-export-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/finalizer-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/form-labeling-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/form-recognition-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/form-vlm-fallback-connection-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/google-api-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/handwriting-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/inference-layout-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/inline-style-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/local-ai-processing-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/local-vlm-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/ocr-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/omr-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/open-ai-api-endpoint-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/open-ai-languages-detection-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/open-ai-picture-alt-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/pp-text-det-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/pp-text-rec-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/preprocessing-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/reading-order-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/segmenter-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/table-recognition-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/vision-acceleration-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/vision-descriptor-settings.md)
- [Per-document override](/api/python/settings/vision/advanced/words-detection-settings.md)