List info

Returns the broker's identity and the org's stream count.

GET /v1/mq/info

Addresshttps://api.hanzo.ai/v1/mq/info
MethodGET
Operationget_mq_info
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the broker's identity and the org's stream count.

Request

GET /v1/mq/info takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200mq.infoOutok
defaultproblem-detailsrefused

200 body — 6 fields.

FieldInTypeAlwaysDescription
jetstreambodyboolean—JetStream is true when durable streams are enabled.
max_payloadbodyinteger (int64)—MaxPayload is the broker's message-size ceiling in bytes.
server_idbodystring—Server is the broker's server id.
server_namebodystring—Name is the broker's server name.
streamsbodyinteger (int64)—Streams is the org's stream count.
versionbodystring—Version is the broker's server version.

Failure carries the platform error shape — see Errors.

Examples

hanzo mq info
import { Configuration, MqApi } from 'hanzoai';

const api = new MqApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMqInfo();
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MqApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MqApi(client).get_mq_info()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.MqAPI.GetMqInfo(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, mq_api};

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

let result = mq_api::get_mq_info(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MqApi;

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

var result = new MqApi(client).getMqInfo();
curl https://api.hanzo.ai/v1/mq/info \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool mq, op get_mq_info — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

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

MQ API · All Hanzo APIs · Interactive reference

Was this page useful?