Advanced settings

Read and update the workspace-wide settings behind the application's Advanced configuration tab — quotas, retention, attachment limits, the MCP gallery and managed-credentials URLs, and feature toggles.

All paths are relative to the base URL and require an Authorization: Bearer YOUR_API_KEY header.

Every settings endpoint is admin only, matching who can see the Advanced tab in the application.

The settings object

GET and PATCH both return the full settings object — one flat, typed record. The field names are the configuration keys; values are natively typed (integer, boolean, or string).

Field	Type	Description
MAX_WORK_ITEM_PAYLOAD_SIZE_IN_KB	integer	Maximum work item JSON payload size, in KB.
MAX_WORK_ITEM_FILE_ATTACHMENT_SIZE_IN_MB	integer	Maximum work item file attachment size, in MB.
MAX_AGENT_FILE_ATTACHMENT_SIZE_IN_MB	integer	Maximum agent and thread file attachment size, in MB.
MAX_AGENTS	integer	Maximum number of agents in this workspace.
MAX_PARALLEL_WORK_ITEMS_IN_PROCESS	integer	Maximum number of work items processed in parallel.
MAX_MCP_SERVERS_IN_AGENT	integer	Maximum number of configured MCP servers in the workspace.
AGENT_THREAD_RETENTION_PERIOD	integer	Retention period for agent threads, in days.
POSTGRES_POOL_MAX_SIZE	integer	Maximum PostgreSQL connection pool size.
MAX_CACHE_SIZE_IN_BYTES	integer	Maximum cache size, in bytes.
WORK_ITEM_TIMEOUT_SECONDS	integer	Execution timeout for a single work item, in seconds.
MAX_SCHEDULES_PER_AGENT	integer	Maximum number of scheduled work items per agent.
DATA_FRAME_MATERIALIZATION_ROW_LIMIT	integer	Maximum number of rows to materialize from computed DataFrames.
DATA_FRAMES_AS_SDM	boolean	Enable dynamic SDM generation from materialized DataFrames.
HIDE_WELCOME_PAGE	boolean	Hide the Welcome page from the sidebar for all users.
MCP_GALLERY_BASE_URL	string	Sema4.ai MCP Gallery URL. Empty hides Sema4.ai-provided servers from the gallery.
MICROSOFT_OAUTH_CLIENT_ID	string	Client ID of the Microsoft Entra app for managed-credentials Microsoft MCP installs. Empty disables managed mode.

Get settings

GET /settings

Returns the full settings object.

curl 'https://{your-deployment-host}/tenants/{tenant-id}/api/v2/settings' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Update settings

PATCH /settings

Partial upsert — only the fields present in the body are applied; omitted fields are left untouched.

curl -X PATCH 'https://{your-deployment-host}/tenants/{tenant-id}/api/v2/settings' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "MAX_AGENTS": 250, "HIDE_WELCOME_PAGE": true }'

Validation runs server-side and applies to the combined final state: per-key range rules (some require >= 1), the constraint between MAX_PARALLEL_WORK_ITEMS_IN_PROCESS and POSTGRES_POOL_MAX_SIZE, and string-emptiness rules. A violation returns 400 and no values are written. Returns the full settings object after applying the changes.

Reset a setting

DELETE /settings/{setting}

Resets a single setting to its built-in default and re-runs any side effects (e.g. resizing the PostgreSQL pool). {setting} must be one of the field names above, otherwise the call returns 404. Returns 204 No Content.

curl -X DELETE 'https://{your-deployment-host}/tenants/{tenant-id}/api/v2/settings/MAX_AGENTS' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Branding Document Intelligence