Get settings

GET

/v1/settings

const url = 'https://your-machine.your-tailnet.ts.net/v1/settings';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://your-machine.your-tailnet.ts.net/v1/settings \
  --header 'Authorization: Bearer <token>'

Secrets come back only as whether they’re set and their last 4 characters.

Authorizations

bearer
apiKey

Responses

200

Settings.

application/json

object

settings

object

publicUrl

string | null

webhookUrl

string | null

docsUrl

string | null

incomingStreamUrl

string | null

incomingStreamFormat

raw: 16 kHz s16le binary frames. twilio: Twilio Media Streams JSON with 8 kHz mu-law, compatible with Twilio integrations such as Pipecat’s.

string

default: raw

Allowed values: raw twilio

geminiModel

string | null

geminiApiKey

object

configured

boolean

hint

string | null

source

string | null

Allowed values: console env

Example

{
  "settings": {
    "incomingStreamFormat": "raw",
    "geminiApiKey": {
      "hint": "…PEXg",
      "source": "console"
    }
  }
}