Skip to main content
GET
/
secrets
/
{setName}
Get a specific secret set
curl --request GET \
  --url https://api.pipecat.daily.co/v1/secrets/{setName} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.pipecat.daily.co/v1/secrets/{setName}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.pipecat.daily.co/v1/secrets/{setName}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pipecat.daily.co/v1/secrets/{setName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pipecat.daily.co/v1/secrets/{setName}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.pipecat.daily.co/v1/secrets/{setName}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.pipecat.daily.co/v1/secrets/{setName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "region": "us-west",
  "status": "ready",
  "secrets": [
    {
      "fieldName": "API_KEY"
    },
    {
      "fieldName": "DATABASE_URL"
    },
    {
      "fieldName": "JWT_SECRET"
    }
  ]
}
{
  "error": "Cannot retrieve image pull secrets by name",
  "code": "GENERIC_BAD_REQUEST"
}
{
  "error": "Unauthorized",
  "code": "UNAUTHORIZED"
}
{
  "error": "Set not found",
  "code": "NOT_FOUND"
}
{
  "error": "<string>",
  "code": "<string>"
}

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

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[]