Skip to main content
PUT
Set PR preview settings

Authorizations

Authorization
string
header
required

Authentication requires a Pipecat Cloud Private API token.

Generate a Private API key from your Dashboard (Settings > API Keys > Private > Create key) and include it as a Bearer token in the Authorization header.

Path Parameters

agentName
string
required

Name of the project

Body

application/json
secretSet
string | null
required

Secret set every preview mounts, or null to turn previews off

Maximum string length: 255
botPullRequests
boolean

Whether pull requests opened by bots (Dependabot, Renovate, GitHub Apps) get previews too. Left out, the stored setting is kept.

Response

The stored settings

secretSet
string | null

The secret set previews mount, or null when previews are off

botPullRequests
boolean

Whether bot pull requests get previews