OpenapiO11y
Invites one person to the caller's org by email, with the role they will hold…
Invites one person to the caller's org by email, with the role they will hold when they accept.
POST /v1/o11y/invite
| Address | https://api.hanzo.ai/v1/o11y/invite |
| Method | POST |
| Operation | CreateInvite |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Invites one person to the caller's org by email, with the role they will hold when they accept. Deprecated in favor of creating users directly; kept because callers still hold it. Admin gate, enforced by the runtime this op relays to.
Request
4 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
email | body | string | — | Email is the address the invitation goes to. |
frontendBaseUrl | body | string | — | FrontendBaseUrl is the console origin the invite link is built on. |
name | body | string | — | Name is the invitee's display name. |
role | body | string | — | Role is the role they will hold on accepting — ADMIN, EDITOR or VIEWER. |
Response
| Status | Body | Meaning |
|---|---|---|
201 | o11y.O11yInviteOut | created |
201 body — 11 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.O11yInvite | — | |
data.createdAt | body | string (date-time) | — | CreatedAt is when it was created. |
data.email | body | string | — | Email is the address it was sent to. |
data.id | body | string | — | ID is the invitation's id. |
data.inviteLink | body | string | — | InviteLink is the full link mailed to them. |
data.name | body | string | — | Name is the invitee's display name. |
data.orgId | body | string | — | OrgID is the org they are invited into. |
data.role | body | string | — | Role is the role the invitee will hold. |
data.token | body | string | — | Token is the secret that redeems it. |
data.updatedAt | body | string (date-time) | — | UpdatedAt is when it last changed. |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y invite createimport { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.createInvite({ email: "<email>", frontendBaseUrl: "<frontendBaseUrl>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).create_invite(email="<email>", frontend_base_url="<frontendBaseUrl>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.CreateInvite(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, o11y_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = o11y_api::create_invite(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new O11yApi(client).createInvite();curl -X POST https://api.hanzo.ai/v1/o11y/invite \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "<email>",
"frontendBaseUrl": "<frontendBaseUrl>"
}'The door reaches o11y through the o11y tool, which names its 340 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_o11y_alert_last"
}
}
}'How is this guide?