Skip to content
Documentation
GuidesAPI ReferenceIntegrations
ArenaPlatform
API Reference/Workspace Settings

Get Workspace Settings

GET/v1/settings

Authorization

Authorizationstring · headerRequired

Workspace session token sent as Bearer <token>. Authentication guide

Parameters

workspace_idquery · stringRequired

Responses

200Workspace settings.
application/json
guardrailsobject
Show nested fields
piiboolean
profanityboolean
moderationboolean
lang_enforceboolean
langsstring
max_minutesnumber | null
blockliststring
privacyobject
Show nested fields
store_transcriptsboolean
store_audioboolean
allow_trainingboolean
zero_retentionboolean

Zero data retention for every provider family.

zdrobject

Zero data retention per provider family for this workspace. It adds to the account's privacy settings and can only restrict. A patch keeps the families it leaves out.

Show nested fields
otherboolean
anthropicboolean
openaiboolean
googleboolean
xaiboolean
routingobject
Show nested fields
sortstring

Values: "balanced""price""latency""speed""quality"

orderstring
ignorestring
allowed_modelsstring

Comma- or newline-separated model ID patterns used as a hard allowlist for managed STT and TTS routes. Supports * wildcards; empty means all supported models.

cost_qualityinteger

Balanced-sort weighting from pure quality (0) to lowest estimated cost (10).

Minimum 0 · Maximum 10

prevent_overridesboolean

When true, request-level routing preferences cannot replace workspace routing defaults.

max_pricenumber | null

Maximum estimated STT price per audio minute.

max_price_1knumber | null

Maximum estimated TTS price per 1,000 generated characters.

fallbacksboolean
settingsobject
Show nested fields
default_routestring
regionstring
preferencesobject
Show nested fields
routestring
formatstring

Values: "json""verbose_json""text""srt""vtt"

timestampsstring

Values: "none""segment""word""both"

densitystring

Values: "comfortable""compact"

mask_keysboolean
400Request validation failed.
application/json
errorobjectRequired
Show nested fields
codestringRequired
messagestringRequired
paramstring | null
request_idstring | null
metadataobject

Typed detail for some refusals. budget_exceeded (402): limit (key_budget or workspace_budget) and budget with scope, period, limit, usage and resets_at. key_limit_exceeded (402): limit key_spend_limit. access_denied (403): policy (workspace or key), rule (models, providers or products), product, provider and model.

401Authentication is missing or invalid.
application/json
errorobjectRequired
Show nested fields
codestringRequired
messagestringRequired
paramstring | null
request_idstring | null
metadataobject

Typed detail for some refusals. budget_exceeded (402): limit (key_budget or workspace_budget) and budget with scope, period, limit, usage and resets_at. key_limit_exceeded (402): limit key_spend_limit. access_denied (403): policy (workspace or key), rule (models, providers or products), product, provider and model.

403Authenticated principal lacks permission.
application/json
errorobjectRequired
Show nested fields
codestringRequired
messagestringRequired
paramstring | null
request_idstring | null
metadataobject

Typed detail for some refusals. budget_exceeded (402): limit (key_budget or workspace_budget) and budget with scope, period, limit, usage and resets_at. key_limit_exceeded (402): limit key_spend_limit. access_denied (403): policy (workspace or key), rule (models, providers or products), product, provider and model.

500Internal server error.
application/json
errorobjectRequired
Show nested fields
codestringRequired
messagestringRequired
paramstring | null
request_idstring | null
metadataobject

Typed detail for some refusals. budget_exceeded (402): limit (key_budget or workspace_budget) and budget with scope, period, limit, usage and resets_at. key_limit_exceeded (402): limit key_spend_limit. access_denied (403): policy (workspace or key), rule (models, providers or products), product, provider and model.