Configuration Reference¶

SnowConnection Parameters¶

Parameter	Type	Default	Description
`instance_url`	`str`	required	Full URL of your ServiceNow instance (e.g. `https://mycompany.service-now.com`).
`username`	`str`	`None`	ServiceNow username. Required for basic auth and OAuth password grant.
`password`	`str`	`None`	ServiceNow password.
`client_id`	`str`	`None`	OAuth client ID. Enables OAuth when combined with `client_secret`.
`client_secret`	`str`	`None`	OAuth client secret.
`token`	`str`	`None`	Pre-obtained bearer token. When set, all other credentials are ignored.
`page_size`	`int`	`100`	Records per API call (1-10,000). Larger values reduce the number of HTTP calls but increase memory per page.
`timeout`	`int`	`60`	HTTP request timeout in seconds. Increase for slow instances or large payloads.
`max_retries`	`int`	`3`	Maximum retry attempts for transient failures (429, 502, 503, 504).
`retry_backoff`	`float`	`1.0`	Base delay (seconds) between retries. Doubles on each attempt (exponential backoff).
`request_delay`	`float`	`0.0`	Minimum seconds between consecutive API requests. Set to `0.1` for ~600 req/min pacing.
`display_value`	`str`	`"true"`	Controls `sysparm_display_value`. `"true"` returns human-readable labels. `"false"` returns raw values. `"all"` returns both in `{display_value, value}` dicts.
`proxy`	`str`	`None`	Proxy URL (e.g. `http://proxy:8080`). Applied to all HTTP and HTTPS requests.
`verify`	`bool \| str`	`True`	SSL verification. `True` uses system CA bundle. Pass a file path for custom CA certificates. `False` disables verification.

Loader Common Parameters¶

All loaders accept these parameters (inherited from BaseSnowLoader):

Parameter	Type	Default	Description
`connection`	`SnowConnection`	required	An initialized connection instance.
`query`	`str`	`None`	ServiceNow encoded query string for filtering records.
`fields`	`list[str]`	`None`	Specific fields to request. `None` returns all fields.
`include_journals`	`bool`	`False`	Fetch and append work notes/comments from `sys_journal_field`.

CMDBLoader Extra Parameters¶

Parameter	Type	Default	Description
`ci_class`	`str`	`"cmdb_ci"`	CMDB class table to query. Use `"cmdb_ci_server"`, `"cmdb_ci_service"`, etc.
`include_relationships`	`bool`	`False`	Traverse the relationship graph via `cmdb_rel_ci`. Adds 2 API calls per CI.
`max_relationship_workers`	`int`	`2`	Number of concurrent threads for relationship queries.

LlamaIndex Adapter Extra Parameters¶

Parameter	Type	Default	Description
`excluded_llm_metadata_keys`	`list[str]`	`["sys_id"]`	Metadata keys to exclude from LLM processing. These remain in the metadata dict but are marked so embedding models and LLMs skip them.

Environment Variables¶

snowloader does not read environment variables directly. However, the example scripts in examples/ use these conventions:

Variable	Description
`SNOW_INSTANCE`	ServiceNow instance URL
`SNOW_USER`	ServiceNow username
`SNOW_PASS`	ServiceNow password