Create a Secret

POST

secrets

Create a Secret

curl --request POST \
  --url https://api.browserbase.com/v1/secrets \
  --header 'Content-Type: application/json' \
  --header 'X-BB-API-Key: <api-key>' \
  --data '
{
  "secretKey": "<string>",
  "sealedSecretValue": "<string>",
  "keypairId": "<string>"
}
'

import requests

url = "https://api.browserbase.com/v1/secrets"

payload = {
    "secretKey": "<string>",
    "sealedSecretValue": "<string>",
    "keypairId": "<string>"
}
headers = {
    "X-BB-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-BB-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({secretKey: '<string>', sealedSecretValue: '<string>', keypairId: '<string>'})
};

fetch('https://api.browserbase.com/v1/secrets', 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.browserbase.com/v1/secrets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'secretKey' => '<string>',
    'sealedSecretValue' => '<string>',
    'keypairId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-BB-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.browserbase.com/v1/secrets"

	payload := strings.NewReader("{\n  \"secretKey\": \"<string>\",\n  \"sealedSecretValue\": \"<string>\",\n  \"keypairId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-BB-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.browserbase.com/v1/secrets")
  .header("X-BB-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"secretKey\": \"<string>\",\n  \"sealedSecretValue\": \"<string>\",\n  \"keypairId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.browserbase.com/v1/secrets")

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

request = Net::HTTP::Post.new(url)
request["X-BB-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"secretKey\": \"<string>\",\n  \"sealedSecretValue\": \"<string>\",\n  \"keypairId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "secretKey": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

Authorizations

X-BB-API-Key

string

header

required

Your Browserbase API Key.

Body

application/json

secretKey

string

required

The name to store the secret value under.

sealedSecretValue

string

required

The secret value encrypted with HPKE. To seal the secret value before sending, get the project's public key from GET /v1/secrets/keypair. Decode the publicKey using base64 into the raw 32-byte public key. Then, use HPKE Base mode (RFC 9180) with the following algorithm suite: DHKEM(X25519, HKDF-SHA256), HKDF-SHA256, and AES-256-GCM. Set both info and additional authenticated data (AAD) to an empty byte string. Then, create a new sender context using the public key and these settings, and encrypt the secret value as one message. Put the 32-byte encapsulated key before the ciphertext and keep the authentication tag at the end of the ciphertext. Encode the combined bytes with standard base64. Send the result as sealedSecretValue: base64(enc || ciphertext)

keypairId

string

required

The id returned by GET /v1/secrets/keypair, identifying the keypair whose public key encrypted the value. Recorded with the secret so decryption stays correct across keypair rotation.

Response

The request has succeeded and a new resource was created.

string

required

Unique identifier of the secret.

secretKey

string

required

The name the secret value is stored under.

⌘I

Create a Secret

curl --request POST \
  --url https://api.browserbase.com/v1/secrets \
  --header 'Content-Type: application/json' \
  --header 'X-BB-API-Key: <api-key>' \
  --data '
{
  "secretKey": "<string>",
  "sealedSecretValue": "<string>",
  "keypairId": "<string>"
}
'

import requests

url = "https://api.browserbase.com/v1/secrets"

payload = {
    "secretKey": "<string>",
    "sealedSecretValue": "<string>",
    "keypairId": "<string>"
}
headers = {
    "X-BB-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-BB-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({secretKey: '<string>', sealedSecretValue: '<string>', keypairId: '<string>'})
};

fetch('https://api.browserbase.com/v1/secrets', 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.browserbase.com/v1/secrets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'secretKey' => '<string>',
    'sealedSecretValue' => '<string>',
    'keypairId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-BB-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.browserbase.com/v1/secrets"

	payload := strings.NewReader("{\n  \"secretKey\": \"<string>\",\n  \"sealedSecretValue\": \"<string>\",\n  \"keypairId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-BB-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.browserbase.com/v1/secrets")
  .header("X-BB-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"secretKey\": \"<string>\",\n  \"sealedSecretValue\": \"<string>\",\n  \"keypairId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.browserbase.com/v1/secrets")

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

request = Net::HTTP::Post.new(url)
request["X-BB-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"secretKey\": \"<string>\",\n  \"sealedSecretValue\": \"<string>\",\n  \"keypairId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "secretKey": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

Overview

SDKs

APIs

Authorizations

Body

Response