Get settings

Reads the caller org's configuration for one product, with every secret field MASKED — only the names of the set secrets come back, never their values, which live in KMS.

GET /v1/settings/{product}

Settings → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/settings/{product}`
Method	`GET`
Operation	`get_settings_by_product`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reads the caller org's configuration for one product, with every secret field MASKED — only the names of the set secrets come back, never their values, which live in KMS. A product the org has never configured is not a 404: it answers 200 with an empty config object, so the console's Settings tab always renders and merges its own display defaults on top.

Request

1 field.

Field	In	Type	Required	Description
`product`	path	string	yes	Product is the catalog slug, from the path.

Response

Status	Body	Meaning
`200`	settings.View	ok
`default`	problem-details	refused

200 body — 5 fields.

Field	In	Type	Always	Description
`config`	body	any	—	Config is the product's non-secret configuration, an opaque JSON object the server stores and returns verbatim.
`createdAt`	body	string	—	CreatedAt is when this configuration was first written, RFC 3339 UTC.
`product`	body	string	—	Product is the catalog slug this configuration belongs to.
`secretKeys`	body	string[]	—	SecretKeys names the secret fields that ARE set.
`updatedAt`	body	string	—	UpdatedAt is when this configuration was last written, RFC 3339 UTC.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo settings get <product>

.ts

.py

.go

.rs

.java

import { Configuration, SettingsApi } from 'hanzoai';

const api = new SettingsApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getSettingsByProduct({ product: 'product' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import SettingsApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = SettingsApi(client).get_settings_by_product(product='product')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.SettingsAPI.GetSettingsByProduct(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, settings_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = settings_api::get_settings_by_product(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.SettingsApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new SettingsApi(client).getSettingsByProduct();

curl https://api.hanzo.ai/v1/settings/<product> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches settings through the settings tool, which names its 2 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_setting"
         }
       }
     }'

Settings API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList rates NextReplace settings