Reports whether one of this brand's shared embedded apps (cms, erp, help) may…

Reports whether one of this brand's shared embedded apps (cms, erp, help) may be framed by the caller and is actually running, so a console module can…

GET /v1/account/embed

Account → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/account/embed`
Method	`GET`
Operation	`get_account_embed`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reports whether one of this brand's shared embedded apps (cms, erp, help) may be framed by the caller and is actually running, so a console module can choose between the embed and the provision panel.

It answers two questions the browser cannot answer for itself. ENTITLEMENT is server-authoritative: each app is a single shared per-BRAND instance, so only a member of the owning brand org — or a SuperAdmin — is given the embed URL; every other caller gets phase "not-entitled" and no URL. REACHABILITY is a probe of that origin, which a cross-origin page cannot read for itself.

The probed host is always <app>.<this deployment's own brand domain>: no part of it comes from the request, so this can never be steered into probing an arbitrary origin.

Request

1 field.

Field	In	Type	Required	Description
`app`	query	string	—	App is the embedded app to report on: cms (Content Studio), erp or help.

Response

Status	Body	Meaning
`200`	embedStatusResp	ok

200 body — 6 fields.

Field	In	Type	Always	Description
`app`	body	string	—	App is the app this verdict is about.
`embedUrl`	body	string	—	EmbedURL is the in-app landing URL to frame.
`entitled`	body	boolean	—	Entitled is whether the caller's org may frame this brand-owned app.
`origin`	body	string	—	Origin is the app's origin on this deployment's own brand domain.
`phase`	body	string	—	Phase is the verdict in one word: not-entitled, not-provisioned or ready.
`reachable`	body	boolean	—	Reachable is whether the app answered the liveness probe.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

import { Configuration, AccountApi } from 'hanzoai';

const api = new AccountApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getAccountEmbed();

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AccountApi(client).get_account_embed()

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

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

use hanzo_cloud::apis::{configuration::Configuration, account_api};

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

let result = account_api::get_account_embed(&cfg, Default::default()).await?;

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

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new AccountApi(client).getAccountEmbed();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl https://api.hanzo.ai/v1/account/embed \
  -H "Authorization: Bearer $HANZO_API_KEY"

The door reaches account through the account tool, which names its 8 operations with its own verbs — this one among them, under a name only the door 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_appearance"
         }
       }
     }'

Account API · All Hanzo APIs · Interactive reference

Reports whether one of this brand's shared embedded apps (cms, erp, help) may…

Request

Response

Examples

On this page