Get Secret Set Details

Retrieve key and value pairs for a specific secret set.

GET /secrets/{setName}

Get a specific secret set

cURL

curl --request GET \
  --url https://api.pipecat.daily.co/v1/secrets/{setName} \
  --header 'Authorization: Bearer <token>'

200

{
  "region": "us-west",
  "status": "ready",
  "secrets": [
    {
      "fieldName": "API_KEY"
    },
    {
      "fieldName": "DATABASE_URL"
    },
    {
      "fieldName": "JWT_SECRET"
    }
  ]
}

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 retrieve

Required string length: 3 - 63

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

Response

200

application/json

Secret set details, including readiness status

region · string

The region where the secret set is stored

status · enum<string>

Readiness state. pending while provisioning is in flight, ready once the set can be bound to a deploy, failed if provisioning could not complete.

Available options: pending, ready, failed

errorMessage · string

Customer-facing message returned only when status is failed. Generic by design — internal diagnostic details are kept in platform logs.

secrets · object[]

Show child attributes