Skip to main content
PATCH
/
insight
/
{rec_id}
/
setup
Update Setup
curl --request PATCH \
  --url https://api.example.com/insight/{rec_id}/setup/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "goals": "<string>",
  "notes": "<string>",
  "guide": "<string>",
  "custom_prompt": "<string>",
  "participant_count": 8,
  "respondent_known_names": [
    "<string>"
  ],
  "language": "<string>",
  "report_language": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

rec_id
string<uuid>
required

Body

application/json

Request model for updating setup configuration without generating reports.

goals
string | null

Research goals

Maximum string length: 10000
notes
string | null

Additional notes

Maximum string length: 20000
guide
string | null

Interview guide

Maximum string length: 20000
custom_prompt
string | null

Custom prompt for Custom report generation

Maximum string length: 15000
participant_count
integer | null

Number of participants from 1 to 15

Required range: 1 <= x <= 15
respondent_known_names
string[]

List of respondent names

language
string | null

Language for transcription

report_language
string | null

Language for reports

Response

Successful Response