curl --request GET \
--url https://api.scripe.io/v1/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scripe.io/v1/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scripe.io/v1/settings', 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.scripe.io/v1/settings",
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.scripe.io/v1/settings"
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.scripe.io/v1/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scripe.io/v1/settings")
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{
"data": {
"project": {
"id": "proj_a1b2c3d4e5f6g7h8",
"name": "<string>",
"type": "PERSONAL_BRAND"
},
"context": {
"language": "<string>",
"germanFormality": "<string>",
"postLengthPreference": 2,
"postLengthPreferenceLabel": "standard",
"formattingPreference": 0,
"formattingPreferenceLabel": "standard",
"emojiPreference": 3,
"emojiPreferenceLabel": "moderate"
},
"toneOfVoice": {
"customInstructions": "<string>",
"customInstructionsEnabled": true,
"ctas": "<string>",
"footer": "<string>",
"footerEnabled": true,
"emojis": [
"<string>"
],
"bulletSymbols": [
"<string>"
],
"userModified": true
},
"organization": {
"customInstructions": "<string>",
"customInstructionsEnabled": true,
"footer": "<string>",
"footerEnabled": true,
"allowPersonalBrandCustomInstructions": true
},
"calendar": {
"timezone": "<string>",
"effectiveTimezone": "Europe/Berlin",
"weekStartsOn": "sunday",
"schedule": {
"slots": [
{
"time": "09:00",
"hour": 11,
"minute": 29,
"days": [
"monday",
"thursday"
]
}
],
"postsPerWeek": 3
}
},
"pillars": [
{
"title": "<string>",
"subtopics": [
"<string>"
],
"order": 123
}
]
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}Read a project's curated settings
Structured fields only: generation-context knobs (language,
formality, length/formatting/emoji preferences), the project
tone-of-voice fields, the workspace custom-instruction state,
calendar settings (pure read — never inserts), and content
pillars. The rendered prompt context is never returned.
Settings writes have no REST surface; they live on MCP behind
two-phase confirmation. Requires the workspace:read scope.
curl --request GET \
--url https://api.scripe.io/v1/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scripe.io/v1/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scripe.io/v1/settings', 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.scripe.io/v1/settings",
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.scripe.io/v1/settings"
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.scripe.io/v1/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scripe.io/v1/settings")
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{
"data": {
"project": {
"id": "proj_a1b2c3d4e5f6g7h8",
"name": "<string>",
"type": "PERSONAL_BRAND"
},
"context": {
"language": "<string>",
"germanFormality": "<string>",
"postLengthPreference": 2,
"postLengthPreferenceLabel": "standard",
"formattingPreference": 0,
"formattingPreferenceLabel": "standard",
"emojiPreference": 3,
"emojiPreferenceLabel": "moderate"
},
"toneOfVoice": {
"customInstructions": "<string>",
"customInstructionsEnabled": true,
"ctas": "<string>",
"footer": "<string>",
"footerEnabled": true,
"emojis": [
"<string>"
],
"bulletSymbols": [
"<string>"
],
"userModified": true
},
"organization": {
"customInstructions": "<string>",
"customInstructionsEnabled": true,
"footer": "<string>",
"footerEnabled": true,
"allowPersonalBrandCustomInstructions": true
},
"calendar": {
"timezone": "<string>",
"effectiveTimezone": "Europe/Berlin",
"weekStartsOn": "sunday",
"schedule": {
"slots": [
{
"time": "09:00",
"hour": 11,
"minute": 29,
"days": [
"monday",
"thursday"
]
}
],
"postsPerWeek": 3
}
},
"pillars": [
{
"title": "<string>",
"subtopics": [
"<string>"
],
"order": 123
}
]
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "not_found",
"message": "<string>",
"request_id": "req_a1b2c3d4e5f6",
"docs_url": "<string>",
"details": "<unknown>"
}
}Authorizations
Pass Authorization: Bearer scripe_sk_live_<...> (or
scripe_sk_test_<...> for test keys) on every request. Keys
are scoped to a single workspace and can be revoked from the
Scripe dashboard.
The same header also accepts an OAuth 2.1 access token
(scripe_oat_*); both credentials share one scope vocabulary
and every operation below documents the scope it requires.
An API key can hold every scope named on this surface except
webhooks:manage, which is grantable to OAuth tokens only
today — the webhook-endpoint operations answer
403 scope_missing to every API key. Operations that name no
scope accept any valid token of the workspace.
Headers
Pin the API version. Format YYYY-MM-DD. Omit to receive the
currently rolling default. Unknown versions return 400 version_unsupported.
"2026-08-10"
Query Parameters
"proj_a1b2c3d4e5f6g7h8"
Response
The project's settings.
Show child attributes
Show child attributes