v1

latestOpenAPI 3.0.02026-08-04891301.4 MB

Update thread settings

Updates the settings for the specified thread. Only fields included in the settings map are modified; omitted fields retain their current values.

The authenticated user must own the thread or be a member of its workspace. Returns the full settings object reflecting the state after the update. Validation errors are returned as 422 Unprocessable Entity.

put/api/v1/threads/{thread}/settings

Path parameters

threadstring required

Thread ID (thr_...). Must belong to the authenticated user's workspace.

Request body

settingsobject required

Map of settings fields to update. Include only the keys you want to change.

Example request

{
  "settings": {}
}

Response

Successful response

agent_enabledboolean

Whether the AI agent is active for this thread. true enables AI responses; false disables them. Defaults to true when settings have not been explicitly configured.

Example response

{
  "agent_enabled": true
}