Skip to main content
PATCH
/
rtstream
/
{stream_id}
/
index
/
scene
/
{scene_index_id}
Update RTStream scene index prompt
curl --request PATCH \
  --url https://api.videodb.io/rtstream/{stream_id}/index/scene/{scene_index_id} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "prompt": "Updated scene description prompt"
}
'
{
  "success": true,
  "message": "Operation successful"
}
Update the prompt used by a scene index on a real-time stream. The new prompt takes effect for subsequent scene descriptions.
  • Only the prompt field can be updated
  • Changes apply to future scene descriptions, not retroactively

Authorizations

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

​
stream_id
string
required
Example:

"rts-12345"

​
scene_index_id
string
required
Example:

"scene-idx-12345"

Body

application/json
​
prompt
string
required
Example:

"Updated scene description prompt"

Response

200 - application/json

Scene index prompt updated

​
success
boolean
Example:

true

​
message
string
Example:

"Operation successful"