Create or Update Secrets

Create or update a secret set and its values

PUT /secrets/{setName}

cURL

regularSecrets

curl --request PUT \
  --url https://api.pipecat.daily.co/v1/secrets/{setName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "secrets": [
    {
      "secretKey": "API_KEY",
      "secretValue": "your-api-key"
    },
    {
      "secretKey": "DATABASE_URL",
      "secretValue": "postgresql://user:pass@host:5432/db"
    }
  ],
  "region": "us-west"
}
'

202

Example

{
  "status": "OK",
  "region": "us-west"
}

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

setName · string · required

Name of the secret set to create or update

Required string length: 3 - 63

Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

Body

application/json

Option 1

Option 2

secrets · object[] · required

Array of secret key-value pairs

Minimum array length: 1

Show child attributes

region · string

The region where the secret set will be created. If not specified, defaults to the organization's default region. Secrets must be in the same region as the agents that use them. Cannot be changed after creation.

Example:

"us-west"

Response

202

application/json

Secret set accepted. Values have been stored and the set is being provisioned into the target region in the background. Poll GET /secrets/{setName} until status is ready before binding it to a deploy.

status · enum<string> · required

Available options: OK

region · string · required

The region where the secret set was created or exists