Studies

Update a study's settings

Sets whether participant recordings are processed for visual analysis. That is the only setting this API writes — everything else about a study is authored in the Outset app, and publishing has its own endpoint because it needs its own scope.

Enabling visual analysis starts paid processing of every recording the study captures from then on, and of recordings captured in the last 14 days whose interviews have already finished — the reconciliation sweep re-drives those.

Refused for a study in a demo project, while the organization is suspended, and on a plan that does not include authoring studies.

A user-delegated token is refused with 403. Visual analysis is turned on by Outset or a partner, never by a researcher — the same rule the Outset app applies.

Requires the studies:write partner scope.

patch/v2/studies/{study_id}/

Request

  • Base URL: https://api.outset.ai
  • URL: https://api.outset.ai/v2/studies/{study_id}/
  • Auth: HTTP bearer

Path parameters

study_idstring uuid required

Request body

visual_intelligence_enabledboolean

Turn visual analysis of participant recordings on or off for this study. This is paid processing — enabling it starts incurring cost on every recording the study captures from that point on, and on recordings captured in the last 14 days whose interviews have already finished.

Response

Changes

No recorded changes to this operation across all 1 revision of this API.