Skip to main content

Get Segment Settings

Get settings for a specific segment (aiml or auth). Returns default values if no settings have been configured.

Path Parameters

segment
string
required
The settings segment to retrieve (“aiml” or “auth”)

Response

segment
string
The settings segment
settings
object
Settings data for the segment (structure varies by segment type)
version_id
uuid
Version ID of the settings (null if using defaults)
updated_at
string
ISO 8601 timestamp of last update (null if using defaults)

Update AI/ML Settings

Update AI/ML settings segment.

Body Parameters

provider_id
string
AI provider UUID
model
string
Model name to use
temperature
number
Model temperature setting (0.0-2.0)
deny_words
array
Array of words to deny/filter
langfuse_enabled
boolean
Whether Langfuse tracking is enabled
allow_user_model_selection
boolean
Whether users can select their own model

Response

Same as Get Segment Settings.

Update Auth Settings

Update authentication settings segment.

Body Parameters

auth_google_enabled
boolean
Whether Google authentication is enabled
auth_github_enabled
boolean
Whether GitHub authentication is enabled
auth_microsoft_enabled
boolean
Whether Microsoft authentication is enabled
auth_local_enabled
boolean
Whether local (email/password) authentication is enabled

Response

Same as Get Segment Settings.

Get Settings History

Get settings version history with pagination and computed changes.

Query Parameters

limit
integer
default:"50"
Number of history entries to return (1-100)
offset
integer
default:"0"
Number of entries to skip for pagination
segment
string
Filter changes by segment (“aiml” or “auth”)

Response

history
array
Array of settings history entries
total
integer
Total number of history entries

Rollback to Version

Rollback all settings to a specific version. Creates a new version with the same values as the target version.

Path Parameters

version_id
uuid
required
The version ID to rollback to

Body Parameters

reason
string
Optional reason for the rollback

Response

id
uuid
New version ID created by the rollback
user_id
uuid
User who performed the rollback
change_type
string
Will be “rollback”
source_version_id
uuid
The version being replaced (current)
target_version_id
uuid
The version being restored
change_reason
string
Reason for the rollback
created_at
string
ISO 8601 timestamp of the rollback
updated_at
string
ISO 8601 timestamp of the rollback

Get Latest Settings (Legacy)

Get the latest settings version. Returns null if no settings have been configured.

Response

Returns the complete settings object or null.

Create Settings (Legacy)

Create a new settings version. Returns existing settings if no changes detected.

Body Parameters

model
string
AI model name
temperature
number
Model temperature
deny_words
array
Array of words to deny
langfuse_enabled
boolean
Langfuse tracking status
auth_google_enabled
boolean
Google authentication status
auth_github_enabled
boolean
GitHub authentication status
auth_microsoft_enabled
boolean
Microsoft authentication status
auth_local_enabled
boolean
Local authentication status

Response

Returns the created or existing settings object.

List All Settings (Legacy)

List all settings versions.

Response

settings
array
Array of all settings versions (up to 100)

Build docs developers (and LLMs) love