Update Conversation Secrets

Update secrets for a conversation.

POST /api/conversations/{conversation_id}/secrets

Try it

Update Conversation Secrets

cURL

curl --request POST \
  --url https://api.example.com/api/conversations/{conversation_id}/secrets \
  --header 'Content-Type: application/json' \
  --data '{
  "secrets": {}
}'

200

{
  "success": true
}

Path Parameters

conversation_id · string<uuid> · required

Body

application/json

Payload to update secrets in a conversation.

secrets · Secrets · object · required

Dictionary mapping secret keys to values

Show child attributes

secrets. {key} · LookupSecret · object

A secret looked up from some external url

LookupSecret

StaticSecret

Show child attributes

secrets.{key}. url · string · required

secrets.{key}. kind · string · default: LookupSecret

Allowed value: "LookupSecret"

secrets.{key}. description · string | null

Optional description for this secret

secrets.{key}. headers · Headers · object

Show child attributes

secrets.{key}.headers. {key} · string

Response

200

application/json

Successful Response

success · boolean · default: true