Guardrails Reference#

API Reference#

Refer to Guardrails API for the REST API reference.

Name	Description	Default Value
`CONFIG_STORE_PATH`	The local path to the config store when the `local` configuration store provider is used.	`/app/services/guardrails/config-store`
`CONFIG_STORE_PROVIDER`	The configuration store provider.	`local`, file system storage.
`DB_URI`	The URI for database storage for guardrails configurations. SQLite and PostgreSQL are supported.	`sqlite:///guardrails.db`
`DEFAULT_CONFIG_ID`	The configuration ID to use if a request does not specify an ID.	`default`
`DEFAULT_LLM_PROVIDER`	The default LLM provider. For a list of available LLM providers, check the NeMo Guardrails Documentation.	`nim`
`DEMO`	When set to `true`, the microservice configures a demo guardrail configuration.	`false`
`GUARDRAILS_HOST`	The host where the service runs.	`0.0.0.0`
`GUARDRAILS_PORT`	The port that the service listens on.	`7331`
`NIM_ENDPOINT_API_KEY`	The API key for the NIM endpoint. Get one from NVIDIA API Catalog.	None
`NIM_ENDPOINT_URL`	The URL of the NIM endpoint.	NVIDIA API endpoint, `https://integrate.api.nvidia.com/v1`