Skip to Content

Setting Types

CallerPermissions

Evaluated permissions for the current caller on this artifact type.

FieldTypeRequiredDescription
can_createbooleanYesWhether the caller can create new artifacts
can_draftbooleanYesWhether the caller can create/update drafts
can_duplicatebooleanYesWhether the caller can duplicate artifacts
has_accessbooleanNoWhether the caller can view this entity
can_editbooleanNoWhether the caller can edit this entity
can_deletebooleanNoWhether the caller can delete this entity
disabled_reasonstringNoHuman-readable reason if editing is disabled

ColumnInfo

FieldTypeRequiredDescription
namestringYesColumn name
typestringYesColumn data type
nullablebooleanYesWhether the column is nullable

CreateSettingItem

Single setting item for create — no setting_id.

Required fields (name): provide ID or value.

FieldTypeRequiredDescription
idstringNoOptional preset UUID for the new setting artifact
resource_idstringNoOptional preset UUID for the settings_resource snapshot
name_idstringNoREQUIRED FOR CREATE (or pass name). UUID of an existing name resource
namestringNoREQUIRED FOR CREATE (or pass name_id). Name value to resolve or create
description_idstringNoUUID of the description resource
descriptionstringNoDescription value to resolve or create
flag_idsstring[]NoSelected flag option UUIDs — canonical; server derives semantics by flag type/value
active_flag_idstringNoDEPRECATED — use flag_ids. UUID of the active flag option
active_flagbooleanNoDEPRECATED — use flag_ids. Whether the setting is active
department_idsstring[]NoDepartment UUIDs to assign
departmentsstring[]NoDepartment names to resolve
color_idsstring[]NoColor resource UUIDs
logins_idsstring[]NoLogins resource UUIDs to assign
system_idsstring[]NoSystem UUIDs to assign
mcp_idstringNoMCP resource UUID to assign (single)
threshold_idsstring[]NoThreshold UUIDs to assign
provider_key_idsstring[]NoProvider key UUIDs
auth_item_key_idsstring[]NoAuth item key UUIDs
auth_item_value_idsstring[]NoAuth item value UUIDs
auth_idsstring[]NoAuth resource UUIDs to assign
provider_idsstring[]NoProvider resource UUIDs to assign
setting_resource_idsstring[]NoSetting resource UUIDs

DeleteSettingResult

Per-item result within a bulk delete response.

FieldTypeRequiredDescription
successbooleanYesWhether the deletion succeeded
setting_idstringNoUUID of the deleted setting (None when soft-skipped due to not-found)
messagestringYesResult message

DocsApiResponse

FieldTypeRequiredDescription
listPageMetaItemYes
detailPageMetaItemYes
newPageMetaItemYes

DocsResponse

FieldTypeRequiredDescription
namestringYesResource or entry name
typestringYesResource or entry type identifier
descriptionstringYesHuman-readable description
materialized_viewMvInfoNoMaterialized view metadata
tablesTableInfo[]YesRelated database tables
operationsOperationInfo[]YesAvailable operations

EvalSetup

Run-level eval scaffold — first-class on the generate response.

Audit’s **output spread carries this onto <artifact>.generate.completed. Null when no rubric-bearing agent participated.

FieldTypeRequiredDescription
test_idstringYes
invocationsInvocationSlot[]Yes

GenerateConfig

Developer configuration — all optional with sensible defaults.

FieldTypeRequiredDescription
operationsstring[]No
dangerousbooleanNo
paramsobjectNo
group_idstringNo

GenerationsSettingListItem

Single generation group in the setting generations response.

FieldTypeRequiredDescription
group_idstringYesUUID of the generation group
session_idstringNoUUID of the parent session
group_namestringNoName of the generation group
created_atstringNoTimestamp of the generation

GetSettingDraftResponse

FieldTypeRequiredDescription
idstringYesUUID of the draft
created_atstringYesCreation timestamp
generatedbooleanYesWhether this was AI-generated
mcpbooleanYesWhether MCP tooling was used
activebooleanYesWhether this draft is active
session_idstringYesAssociated session UUID
namestringNoImmutable draft label set at create time
system_idsstring[]YesAssociated system UUIDs
auth_item_key_idsstring[]YesAssociated auth item key UUIDs
auth_idsstring[]YesAssociated auth UUIDs
color_idsstring[]YesAssociated color UUIDs
department_idsstring[]YesAssociated department UUIDs
description_idsstring[]YesAssociated description UUIDs
flag_idsstring[]YesAssociated flag UUIDs
item_idsstring[]YesAssociated item UUIDs
name_idsstring[]YesAssociated name UUIDs
provider_idsstring[]YesAssociated provider UUIDs
provider_key_idsstring[]YesAssociated provider key UUIDs
threshold_idsstring[]YesAssociated threshold UUIDs
mcp_idsstring[]No
logins_idsstring[]No
pending_system_idsstring[]NoPending system UUIDs
pending_auth_item_key_idsstring[]NoPending auth item key UUIDs
pending_auth_idsstring[]NoPending auth UUIDs
pending_color_idsstring[]NoPending color UUIDs
pending_department_idsstring[]NoPending department UUIDs
pending_description_idsstring[]NoPending description UUIDs
pending_flag_idsstring[]NoPending flag UUIDs
pending_item_idsstring[]NoPending item UUIDs
pending_name_idsstring[]NoPending name UUIDs
pending_provider_idsstring[]NoPending provider UUIDs
pending_provider_key_idsstring[]NoPending provider key UUIDs
pending_threshold_idsstring[]NoPending threshold UUIDs
pending_mcp_idsstring[]No
pending_logins_idsstring[]No

GroupCall

Tool call referenced by a message.

FieldTypeRequiredDescription
idstringYes
tool_namestringNo
template_namestringNo
toolobjectNo
ledger_statusstringNo
ledger_operationstringNo
ledger_artifactstringNo
ledger_artifact_idstringNo

GroupMessage

Message within a run.

FieldTypeRequiredDescription
idstringYes
rolestringYes
created_atstringNo
text_idsstring[]No
audio_idsstring[]No
image_idsstring[]No
video_idsstring[]No
file_idsstring[]No
call_idsstring[]No
callsGroupCall[]No
reasoningbooleanNoTrue when this row is a chain-of-thought trace persisted alongside the assistant answer (rendered as a collapsed accordion).
in_contextbooleanNoWhether this message is included in the LLM context for the next generation. Mirrors the dedup pass that builds chat history (see in_context_reason).
in_context_reasonstringNoWhy this message is in/out of LLM context. ‘kept’ = included; ‘deduped_read’ = older read-only call to a tool that has a fresher result later in the group; future values may include ‘trimmed_top_n’.

GroupResource

Lightweight \{id, name\} for cross-referencing run-level ids (model_id / agent_id / profile_id) against human-readable names on the analytics panel. Names come from the canonical get_models / get_agents / get_profiles black boxes.

FieldTypeRequiredDescription
idstringYes
namestringNo

GroupRun

Run within a group, with its messages.

Carries token / cost / model / agent / profile attribution so the analytics view can render per-run cost + actor info without a parallel detail shape. profile_id is the authoring profile (human user), agent_id is the LLM-side actor, model_id is the model used by that agent. All optional — runs predating these columns or with unresolved attributions surface None.

FieldTypeRequiredDescription
idstringYes
created_atstringNo
input_tokensintegerNo
output_tokensintegerNo
cached_input_tokensintegerNo
costnumberNo
model_idstringNo
agent_idstringNo
profile_idstringNo
previous_context_start_indexintegerNoIndex in messages where the current run’s own messages begin; earlier rows are previous-context replay. None when the run has no previous context attached.
messagesGroupMessage[]No

ImportField

Field descriptor for CSV import column mapping.

FieldTypeRequiredDescription
keystringYes
labelstringYes
requiredbooleanNo
multibooleanNo
typestringNo
examplestringNo
descriptionstringNo

InvocationSlot

One agent’s slot in a multi-agent generation pool.

Populated by setup_generation_test when an agent carries a rubric. The client uses these IDs to drive the eval workflow: review the candidate’s output, optionally fire a grader against its invocation_id, and promote/reject by call_id via the existing idempotency_key + accept pattern.

FieldTypeRequiredDescription
invocation_idstringYes
agent_idstringYes
rubric_idstringNo

ListFilterOption

Standardized option for list endpoint filter sections.

FieldTypeRequiredDescription
idstringNoUnique identifier for this filter option
namestringNoDisplay name
countintegerNoNumber of matching records
hex_codestringNoHex color code for display
valuestringNoInternal value
typestringNoOption type discriminator

ListFilterSection

Filter section with options and echoed request state.

FieldTypeRequiredDescription
optionsListFilterOption[]NoAvailable filter options
selected_idsstring[]NoCurrently selected filter option IDs
searchstringNoActive search text for filtering

ListSettingApiKey

Key type for list endpoint.

FieldTypeRequiredDescription
key_idstringNoUnique key identifier
namestringNoKey display name
key_maskedstringNoMasked key value for display
descriptionstringNoKey description text
activebooleanNoWhether the key is currently active
department_idsstring[]NoAssociated department IDs

ListSettingApiSetting

Setting type for list endpoint with computed permissions.

FieldTypeRequiredDescription
idstringNoSetting artifact UUID (canonical id; mirrors settings_id)
settings_idstringNoUnique setting identifier
created_atstringNoTimestamp when setting was created
activebooleanNoWhether the setting is currently active
is_inactivebooleanNoWhether the setting is inactive
namestringNoSetting display name
descriptionstringNoSetting description text
department_idsstring[]NoAssociated department IDs
provider_idsstring[]NoProvider resource UUIDs assigned to this setting
auth_idsstring[]NoAuth resource UUIDs assigned to this setting
system_idsstring[]NoSystem resource UUIDs assigned to this setting
can_editbooleanNoWhether the actor can edit this setting
can_deletebooleanNoWhether the actor can delete this setting
can_duplicatebooleanNoWhether the actor can duplicate this setting
pending_statusstringNoLatest soft_calls_mv status: ‘pending’ / ‘accepted’ / ‘rejected’
pending_operationstringNoOperation type (‘create'
pending_call_idstringNocall_id (idempotency key for ack) of the pending op

MvInfo

FieldTypeRequiredDescription
namestringYesMaterialized view name
definitionstringYesSQL definition of the view
columnsColumnInfo[]YesList of columns in the view

OperationInfo

FieldTypeRequiredDescription
namestringYesOperation name
descriptionstringYesHuman-readable description of the operation
paramsParamInfo[]YesList of operation parameters
returnsobjectNoReturn type schema

OperationPrompts

Starter prompts keyed by operation name.

Each key is an operation (e.g. “create”, “search”, “draft”, “export”) and the value is a list of starter prompts for that operation. The client picks from the operations the caller has permission for and rotates through them.

FieldTypeRequiredDescription
promptsobjectNoMap of operation name to starter prompts

PageMetaItem

FieldTypeRequiredDescription
titlestringYes
descriptionstringYes

ParamInfo

FieldTypeRequiredDescription
namestringYesParameter name
typestringYesParameter data type
requiredbooleanYesWhether the parameter is required
defaultanyNoDefault value if not required

ProducedMedia

One asset produced by a generation run.

resource_id is the canonical id the per-artifact download tools accept (e.g. Scenario_Image_Download(image_id=resource_id) for modality="image"). It maps to images_resource.id / videos_resource.id / audios_resource.id depending on the modality.

FieldTypeRequiredDescription
modality"image" | "video" | "audio"Yes
resource_idstringYes
upload_idstringYes
mime_typestringNo
file_sizeintegerNo

ProfileSummary

Caller identity derived from JWT — who you are on this page.

Superset of the old six-field version: now carries everything the client needs so that /\{artifact\}/context fully replaces /profiles/context and the extra getLayoutContextData round-trip can be dropped.

FieldTypeRequiredDescription
namestringYesDisplay name of the authenticated user
rolestringYesRole name (e.g. ‘Super Administrator’)
role_levelintegerYesRole hierarchy level (0 = highest privilege)
department_idsstring[]YesDepartments the user belongs to
artifact_accessstring[]YesArtifact types this role can access (sidebar visibility)
role_permissionsany[][]YesFull (artifact, operation) permission tuples for granular page gating
is_activebooleanYesWhether the user’s profile is active
idstringYesProfile UUID (SocketProvider, ProfileProvider)
themeThemeBundleNoResolved theme: hex primitives + derived oklch tokens + score thresholds
session_idstringNoCurrent session UUID
is_emulationbooleanNoWhether user is in emulation mode (ProfileProvider)
role_resourcesQGetProfileContextV4RoleResource[]NoAll role resources for emulation display (ProfileProvider)
scoped_rolesstring[]NoRoles the user can emulate (ProfileProvider)
activebooleanNoAlias for is_active (ProfileProvider uses this name)

QGetProfileContextV4RoleResource

FieldTypeRequiredDescription
rolestringNo
namestringNo
descriptionstringNo
icon_valuestringNo
color_hexstringNo

RunStatus

Outcome of one watched run.

FieldTypeRequiredDescription
run_idstringYes
status"pending" | "completed" | "failed"Yes
modalitystringNoModality of generated output (image, video, text…)
resource_idsstring[]NoResource UUIDs produced by this run (e.g. images_resource ids)
errorstringNo

SettingAgentCatalogResource

FieldTypeRequiredDescription
agent_idstringNoAgent identifier
namestringNoAgent display name
descriptionstringNoAgent description

SettingAuthCatalogResource

FieldTypeRequiredDescription
idstringNoAuth provider identifier (canonical for picker selection)
auth_idstringNoAuth provider identifier (alias for id)
namestringNoAuth display name
descriptionstringNoAuth description
slugstringNoAuth slug
protocolstringNoAuth protocol
generatedbooleanNoWhether this was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingAuthItemKeyDraftValue

Draft value object for an inline-creatable (auth × item × key) triple.

Same two flows as SettingProviderKeyDraftValue: server encrypts key_value and creates a fresh keys_resource row when supplied.

FieldTypeRequiredDescription
idstringNoExisting auth_item_keys_resource id when known
auth_idstringYesAuth provider identifier
item_idstringYesClaim item identifier
key_idstringNoExisting keys_resource id (optional when key_value provided)
key_valuestringNoPlaintext key/secret. Server encrypts and creates a keys_resource row.
key_namestringNoOptional display name for the new keys_resource row

SettingAuthItemKeyOption

Server-curated (auth × item × key) catalog option for the AuthItemKeys picker.

FieldTypeRequiredDescription
auth_idstringNoAuth provider identifier
item_idstringNoClaim item identifier
key_idstringNoKey identifier
auth_namestringNoAuth display name
item_namestringNoClaim item display name
key_namestringNoKey display name
masked_keystringNoMasked key value for display

SettingAuthItemKeyResource

FieldTypeRequiredDescription
idstringNoAuth item key identifier
auth_idstringNoAuth identifier
item_idstringNoItem identifier
key_idstringNoKey identifier
generatedbooleanNoWhether the auth-item-key pair was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingAuthItemValueDraftValue

Draft value object for an inline-creatable (auth × item × value) triple.

FieldTypeRequiredDescription
idstringNoExisting auth_item_values_resource id when known
auth_idstringYesAuth provider identifier
item_idstringYesClaim item identifier
valuestringYesLiteral claim value

SettingAuthItemValueOption

Server-curated (auth × item) catalog option for the AuthItemValues picker.

FieldTypeRequiredDescription
auth_idstringNoAuth provider identifier
item_idstringNoClaim item identifier
auth_namestringNoAuth display name
item_namestringNoClaim item display name
item_descriptionstringNoClaim item description
encryptedbooleanNoWhether the value must be stored encrypted

SettingAuthItemValueResource

FieldTypeRequiredDescription
idstringNoAuth item value identifier
auth_idstringNoAuth provider identifier
item_idstringNoClaim item identifier
valuestringNoLiteral claim value
generatedbooleanNoWhether the value was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingColorResource

FieldTypeRequiredDescription
idstringNoColor resource identifier
namestringNoColor display name
descriptionstringNoColor description
hex_codestringNoHex color value
typestringNoColor role — ‘primary’, ‘secondary’, ‘accent’, etc.
generatedbooleanNoWhether the color was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingDepartmentResource

FieldTypeRequiredDescription
department_idstringNoDepartment identifier
namestringNoDepartment name
descriptionstringNoDepartment description
generatedbooleanNoWhether the department was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingDescriptionResource

FieldTypeRequiredDescription
idstringNoDescription resource identifier
descriptionstringNoSetting description
generatedbooleanNoWhether the description was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingFieldError

Per-field error from value resolution.

FieldTypeRequiredDescription
fieldstringYesName of the field that failed validation
messagestringYesValidation error message

SettingFlagResource

Flag option row — one per (name, type, value) entry in flags_resource.

FieldTypeRequiredDescription
idstringNoFlag resource identifier
namestringNoFlag display name
typestringNoFlag type (e.g. ‘setting_active’, ‘mcp’)
valuebooleanNoUnderlying bool value of this option
descriptionstringNoFlag description text
icon_idstringNoIcon identifier for the flag
iconstringNoResolved SVG markup (hydrated from icons_resource)
generatedbooleanNoWhether the flag was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingIconCatalogResource

FieldTypeRequiredDescription
icon_idstringNoIcon identifier
namestringNoIcon display name
descriptionstringNoIcon description
valuestringNoIcon value (SVG markup or slug)

SettingItemCatalogResource

FieldTypeRequiredDescription
item_idstringNoClaim item identifier
namestringNoClaim item display name (e.g. clientId)
descriptionstringNoClaim item description
encryptedbooleanNoWhether the item value must be stored encrypted
positionintegerNoDisplay ordering position

SettingKeyCatalogResource

FieldTypeRequiredDescription
key_idstringNoKey identifier
namestringNoKey display name
descriptionstringNoKey description
masked_keystringNoMasked key value for display

SettingLoginDraftValue

Draft value object for an inline-creatable logins_resource row.

FieldTypeRequiredDescription
idstringNoExisting logins_resource id when known
login_typestringYes’auth’ or ‘profile’
auth_idstringNoAuth id — required when login_type=‘auth’
profile_idstringNoProfile id — required when login_type=‘profile’
display_namestringNoOverride label; falls back to Auth/Profile catalog name
icon_idstringNoOverride icon; falls back to defaults

SettingLoginOption

Server-curated catalog option for the Logins picker.

FieldTypeRequiredDescription
login_typestringNo’auth’ or ‘profile’
auth_idstringNoAuth identifier for login_type=‘auth’
profile_idstringNoProfile identifier for login_type=‘profile’
display_namestringNoDefault button label
icon_idstringNoDefault icon (when Auth or Profile catalog provides one)
iconstringNoResolved SVG markup for the icon (when available)

SettingLoginsResource

FieldTypeRequiredDescription
logins_idstringNoLogins resource identifier
profile_idstringNoProfile for test login
auth_idstringNoAuth provider for OIDC login
icon_idstringNoIcon for login button
iconstringNoResolved SVG markup for the icon (hydrated from icons_resource)
display_namestringNoDisplay text for login button
login_typestringNoLogin type: ‘auth’ or ‘profile’
generatedbooleanNoWhether this was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingMcpDraftValue

Draft value object for an inline-creatable mcp row.

FieldTypeRequiredDescription
idstringNoExisting mcp_resource id when known
agent_idstringYesAgent identifier
namestringNoOptional display name — defaults to agent.name
descriptionstringNoOptional description

SettingMcpOption

Server-curated per-agent catalog option for the MCP picker.

FieldTypeRequiredDescription
agent_idstringNoAgent identifier
agent_namestringNoAgent display name
agent_descriptionstringNoAgent description

SettingMcpResource

FieldTypeRequiredDescription
mcp_idstringNoMCP resource identifier
agent_idstringNoAgent providing MCP tools
namestringNoMCP config display name
descriptionstringNoMCP config description
generatedbooleanNoWhether this was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingNameResource

FieldTypeRequiredDescription
idstringNoName resource identifier
namestringNoSetting display name
generatedbooleanNoWhether the name was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingProfileCatalogResource

FieldTypeRequiredDescription
profile_idstringNoProfile identifier
namestringNoProfile display name
descriptionstringNoProfile description

SettingProviderCatalogResource

FieldTypeRequiredDescription
idstringNoProvider identifier (canonical for picker selection)
provider_idstringNoProvider identifier (alias for id)
namestringNoProvider display name
descriptionstringNoProvider description
generatedbooleanNoWhether this was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingProviderKeyDraftValue

Draft value object for an inline-creatable (provider × key) pair.

Two flows:

  • Create-by-value: caller supplies key_value (and optional key_name). Server encrypts it, creates a fresh keys_resource row, and links a provider_keys_resource row for (provider_id, new_key_id).
  • Re-link existing: caller supplies key_id referencing an existing keys_resource row. Server upserts the junction.
FieldTypeRequiredDescription
idstringNoExisting provider_keys_resource id when known
provider_idstringYesProvider identifier
key_idstringNoExisting keys_resource id (optional when key_value provided)
key_valuestringNoPlaintext API key. Server encrypts and creates a keys_resource row.
key_namestringNoOptional display name for the new keys_resource row

SettingProviderKeyOption

Server-curated (provider × key) catalog option for the ProviderKeys picker.

FieldTypeRequiredDescription
provider_idstringNoProvider identifier
key_idstringNoKey identifier
provider_namestringNoProvider display name
key_namestringNoKey display name
masked_keystringNoMasked key value for display

SettingProviderKeyResource

FieldTypeRequiredDescription
idstringNoProvider key identifier
provider_idstringNoProvider identifier
key_idstringNoKey identifier
keystringNoKey value
namestringNoKey display name
descriptionstringNoKey description
generatedbooleanNoWhether the provider-key pair was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingResultItem

Per-item result within a bulk create/update response.

FieldTypeRequiredDescription
successbooleanYesWhether the operation succeeded
setting_idstringNoUUID of the created or updated setting
messagestringYesResult message
errorsSettingFieldError[]NoPer-field validation errors

SettingSystemDraftValue

Draft value object for an inline-creatable systems_resource row.

FieldTypeRequiredDescription
idstringNoExisting systems_resource id when known
namestringYesSystem display name
descriptionstringNoOptional description
agent_idsstring[]NoAgents that this system routes to

SettingSystemResource

FieldTypeRequiredDescription
system_idstringNoSystem identifier
namestringNoSystem display name
descriptionstringNoSystem description
agent_idsstring[]NoLinked agent identifiers
generatedbooleanNoWhether the system was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

SettingThresholdDraftValue

Draft value object for a per-type threshold slider.

Server resolver finds an existing thresholds_resource row matching (type, value) or creates one if none exists, then merges the id into request.threshold_ids (dropping any prior id of the same type so each type keeps exactly one assignment).

FieldTypeRequiredDescription
idstringNoExisting thresholds_resource id when known
typestringYesThreshold type — e.g. ‘success’, ‘warning’, ‘danger’
valueintegerYesInteger threshold value (0–100)

SettingThresholdResource

FieldTypeRequiredDescription
idstringNoThreshold resource identifier
typestringNoThreshold type (e.g. ‘success’)
valueintegerNoThreshold integer value
generatedbooleanNoWhether this was AI-generated
suggestedbooleanNoWhether this item is suggested
selectedbooleanNoWhether this item is selected
pendingbooleanNoWhether this item is pending acceptance

TableInfo

FieldTypeRequiredDescription
namestringYesTable name
columnsColumnInfo[]YesList of columns in the table

ThemeBundle

Full theme payload for a page bootstrap.

Riding along on every /\{artifact\}/context response via ProfileSummary.theme. Layers:

  • primitives / dark_primitives — hex inputs the settings editor reads/writes (light + dark palettes).
  • tokens / dark_tokens — oklch tokens the client paints with. ThemeStyle emits two <style> blocks: one scoped to :root:not(.dark) (light) and one to :root.dark (dark).
  • thresholds — numeric score thresholds for analytics components. Empty-in → empty-out per token: missing values fall through to the matching globals.css default.
FieldTypeRequiredDescription
primitivesThemePrimitivesNoHex inputs from the setting (light palette, for the theme editor)
tokensThemeTokensNoDerived oklch tokens for light mode (SSR CSS-var injection)
dark_primitivesThemePrimitivesNoHex inputs from the setting (dark palette, for the theme editor)
dark_tokensThemeTokensNoDerived oklch tokens for dark mode (SSR CSS-var injection)
thresholdsThresholdsNoScore thresholds resolved from the setting

ThemePrimitives

40 optional fields. The 17 essentials drive the rest; the other 23 are overrides for fine-tuning when derivation isn’t what you want.

Empty primitive → empty token → client falls back to globals.css.

FieldTypeRequiredDescription
backgroundstringNo
primarystringNo
accentstringNo
cardstringNo
sidebarstringNo
muted_foregroundstringNo
ringstringNo
borderstringNo
destructivestringNo
successstringNo
warningstringNo
infostringNo
chart1stringNo
chart2stringNo
chart3stringNo
chart4stringNo
chart5stringNo
foregroundstringNo
card_foregroundstringNo
popoverstringNo
popover_foregroundstringNo
primary_foregroundstringNo
secondarystringNo
secondary_foregroundstringNo
mutedstringNo
accent_foregroundstringNo
destructive_foregroundstringNo
dangerstringNo
danger_foregroundstringNo
inputstringNo
success_foregroundstringNo
warning_foregroundstringNo
info_foregroundstringNo
sidebar_foregroundstringNo
sidebar_primarystringNo
sidebar_primary_foregroundstringNo
sidebar_accentstringNo
sidebar_accent_foregroundstringNo
sidebar_borderstringNo
sidebar_ringstringNo

ThemeTokens

40 fully-resolved CSS variable values (snake_case 1:1 with vars).

FieldTypeRequiredDescription
backgroundstringNo
foregroundstringNo
cardstringNo
card_foregroundstringNo
popoverstringNo
popover_foregroundstringNo
primarystringNo
primary_foregroundstringNo
secondarystringNo
secondary_foregroundstringNo
mutedstringNo
muted_foregroundstringNo
accentstringNo
accent_foregroundstringNo
destructivestringNo
destructive_foregroundstringNo
dangerstringNo
danger_foregroundstringNo
borderstringNo
inputstringNo
ringstringNo
successstringNo
success_foregroundstringNo
warningstringNo
warning_foregroundstringNo
infostringNo
info_foregroundstringNo
chart1stringNo
chart2stringNo
chart3stringNo
chart4stringNo
chart5stringNo
sidebarstringNo
sidebar_foregroundstringNo
sidebar_primarystringNo
sidebar_primary_foregroundstringNo
sidebar_accentstringNo
sidebar_accent_foregroundstringNo
sidebar_borderstringNo
sidebar_ringstringNo

Thresholds

Numeric score thresholds resolved from the active setting.

Server pre-buckets dashboard metrics into success | warning | danger | neutral already, so most components don’t need these values. Surface them for chart reference lines, tooltips, and any client-side bucketing.

FieldTypeRequiredDescription
successintegerYesScore >= this counts as success
warningintegerYesScore >= this counts as warning
dangerintegerYesScore < success threshold but >= this counts as danger; below is neutral/no-data

UpdateSettingItem

Single setting item for update — setting_id required, all fields optional.

Only provided fields are updated (partial update).

FieldTypeRequiredDescription
idstringYesUUID of the setting to update
name_idstringNoUUID of the name resource
namestringNoName value to resolve or create
description_idstringNoUUID of the description resource
descriptionstringNoDescription value to resolve or create
flag_idsstring[]NoSelected flag option UUIDs — canonical; server derives semantics by flag type/value
active_flag_idstringNoDEPRECATED — use flag_ids. UUID of the active flag option
active_flagbooleanNoDEPRECATED — use flag_ids. Whether the setting is active
department_idsstring[]NoDepartment UUIDs to assign
departmentsstring[]NoDepartment names to resolve
color_idsstring[]NoColor resource UUIDs
logins_idsstring[]NoLogins resource UUIDs to assign
system_idsstring[]NoSystem UUIDs to assign
mcp_idstringNoMCP resource UUID to assign (single)
threshold_idsstring[]NoThreshold UUIDs to assign
provider_key_idsstring[]NoProvider key UUIDs
auth_item_key_idsstring[]NoAuth item key UUIDs
auth_item_value_idsstring[]NoAuth item value UUIDs
auth_idsstring[]NoAuth resource UUIDs to assign
provider_idsstring[]NoProvider resource UUIDs to assign
setting_resource_idsstring[]NoSetting resource UUIDs

UpdateSettingPatch

Shared patch for bulk-update-all-matching mode.

Inherits every field from UpdateSettingItem and just relaxes id to optional — the bulk impl stamps the resolved id onto a clone of the patch per matched row, so any client-supplied id is ignored. Sparse semantics: only fields the client sets are written.

FieldTypeRequiredDescription
idstringNoIgnored — bulk impl stamps the resolved setting id per matched row
name_idstringNoUUID of the name resource
namestringNoName value to resolve or create
description_idstringNoUUID of the description resource
descriptionstringNoDescription value to resolve or create
flag_idsstring[]NoSelected flag option UUIDs — canonical; server derives semantics by flag type/value
active_flag_idstringNoDEPRECATED — use flag_ids. UUID of the active flag option
active_flagbooleanNoDEPRECATED — use flag_ids. Whether the setting is active
department_idsstring[]NoDepartment UUIDs to assign
departmentsstring[]NoDepartment names to resolve
color_idsstring[]NoColor resource UUIDs
logins_idsstring[]NoLogins resource UUIDs to assign
system_idsstring[]NoSystem UUIDs to assign
mcp_idstringNoMCP resource UUID to assign (single)
threshold_idsstring[]NoThreshold UUIDs to assign
provider_key_idsstring[]NoProvider key UUIDs
auth_item_key_idsstring[]NoAuth item key UUIDs
auth_item_value_idsstring[]NoAuth item value UUIDs
auth_idsstring[]NoAuth resource UUIDs to assign
provider_idsstring[]NoProvider resource UUIDs to assign
setting_resource_idsstring[]NoSetting resource UUIDs

app__infra__setting__types__DraftFormState

FieldTypeRequiredDescription
name_idstringNoResolved name resource UUID
namestringNoEchoed name value when available
description_idstringNoResolved description resource UUID
descriptionstringNoEchoed description value when available
flag_idsstring[]NoSelected flag option UUIDs
activebooleanNoEchoed setting_active flag state
mcpbooleanNoEchoed mcp flag state
department_idsstring[]NoAssigned department UUIDs
color_idsstring[]NoAssigned color UUIDs
logins_idsstring[]NoAssigned logins resource UUIDs
system_idsstring[]NoAssigned system UUIDs
mcp_idstringNoAssigned MCP resource UUID
threshold_idsstring[]NoAssigned threshold UUIDs
provider_key_idsstring[]NoAssigned provider key UUIDs
auth_item_key_idsstring[]NoAssigned auth item key UUIDs
auth_item_value_idsstring[]NoAssigned auth item value UUIDs
auth_idsstring[]NoAssigned auth resource UUIDs
provider_idsstring[]NoAssigned provider resource UUIDs
provider_keysSettingProviderKeyDraftValue[]NoEchoed (provider × key) value entries with resolved ids
auth_item_keysSettingAuthItemKeyDraftValue[]NoEchoed (auth × key) value entries with resolved ids
auth_item_valuesSettingAuthItemValueDraftValue[]NoEchoed (auth × item × value) entries with resolved ids
mcp_valuesSettingMcpDraftValue[]NoEchoed mcp value entries with resolved ids
system_valuesSettingSystemDraftValue[]NoEchoed system value entries with resolved ids
threshold_valuesSettingThresholdDraftValue[]NoEchoed per-type threshold values with resolved ids
loginsSettingLoginDraftValue[]NoEchoed logins value entries with resolved ids
pending_idsstring[]NoPending resource identifiers

app__infra__setting__types__SectionFilter

FieldTypeRequiredDescription
searchstringNoFilter options by search text
limitintegerNoMax options to return
selectedbooleanNoOnly return selected items
suggestedbooleanNoOnly return suggested items
includebooleanNoInclude this section in response (default true)
parameter_idsstring[]NoReserved for compatibility with shared filter parsing

Last updated on