Skip to main content
PATCH
/
v1
/
console
/
case-studies
/
{case_study_id}
Update Case Study
curl --request PATCH \
  --url http://localhost:8000/v1/console/case-studies/{case_study_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "avatar": "<string>",
  "description": "<string>",
  "document_ids": [
    "<string>"
  ],
  "document_url": "<string>",
  "first_message": "<string>",
  "instructions": [
    "<string>"
  ],
  "is_active": true,
  "llm_model": "<string>",
  "media_url": "<string>",
  "programme_codes": [
    "<string>"
  ],
  "slug": "<string>",
  "stt_language": "<string>",
  "system_prompt": "<string>",
  "time_limit_minutes": 90,
  "title": "<string>",
  "tts_voice": "<string>"
}
'
{
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "is_active": true,
    "slug": "<string>",
    "title": "<string>",
    "avatar": {
      "id": "<string>",
      "is_active": true,
      "name": "<string>",
      "bio": "<string>",
      "image_url": "<string>",
      "role": "<string>",
      "tags": [
        "<string>"
      ]
    },
    "avatar_id": "<string>",
    "description": "<string>",
    "document_ids": [
      "<string>"
    ],
    "document_url": "<string>",
    "first_message": "<string>",
    "instructions": [
      "<string>"
    ],
    "llm_model": "<string>",
    "media_url": "<string>",
    "programme_codes": [
      "<string>"
    ],
    "stt_language": "<string>",
    "system_prompt": "<string>",
    "time_limit_minutes": 123,
    "tts_voice": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "message": "<string>",
  "success": true
}

Authorizations

Authorization
string
header
required

Enter your JWT access token

Path Parameters

case_study_id
string
required

Body

application/json
avatar
string | null
description
string | null
Maximum string length: 5000
document_ids
string[] | null
document_url
string | null
Maximum string length: 1000
first_message
string | null
Maximum string length: 2000
instructions
string[] | null
Maximum array length: 20
is_active
boolean | null
llm_model
string | null
Maximum string length: 100
media_url
string | null
Maximum string length: 1000
programme_codes
string[] | null
slug
string | null
Required string length: 1 - 100
Pattern: ^[a-z0-9-]+$
stt_language
string | null
Maximum string length: 10
system_prompt
string | null
time_limit_minutes
integer | null
Required range: 1 <= x <= 180
title
string | null
Required string length: 1 - 255
tts_voice
string | null
Maximum string length: 100

Response

Successful Response

data
CaseStudyResponse · object
message
string | null
success
boolean
default:true