Create remote connections

Create one connection.

POST /v1/ai/remote-connections

AI → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/ai/remote-connections`
Method	`POST`
Operation	`post_ai_remote-connections`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Create one connection.

Request

1 field, body application/json (required).

Field	In	Type	Required	Description
`(body)`	body	object	yes

Response

Status	Body	Meaning
`200`		Envelope.
`401`	—	No credential, or one this service does not accept.
`403`	—	A valid credential that may not do this.

200 body — 27 fields.

Field	In	Type	Always	Description
`data`	body	any	—	The operation's own result.
`data2`	body	any	—	A second result the operation defines, when it has one.
`msg`	body	string	yes	Empty on success, the reason on failure.
`status`	body	string	yes	One of `ok`, `error`.
`data.clientIp`	body	string	—
`data.clientIpDesc`	body	string	—
`data.code`	body	integer	—
`data.commandCount`	body	integer	—
`data.connectionId`	body	string	—
`data.createdTime`	body	string	—
`data.creator`	body	string	—
`data.endTime`	body	string	—
`data.height`	body	integer	—
`data.message`	body	string	—
`data.mode`	body	string	—
`data.name`	body	string	—
`data.node`	body	string	—
`data.operations`	body	string[]	—
`data.owner`	body	string	—
`data.protocol`	body	string	—
`data.recording`	body	string	—
`data.reviewed`	body	boolean	—
`data.startTime`	body	string	—
`data.status`	body	string	—
`data.userAgent`	body	string	—
`data.userAgentDesc`	body	string	—
`data.width`	body	integer	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo ai remote-connections create

.ts

.py

.go

.rs

.java

import { Configuration, AiApi } from 'hanzoai';

const api = new AiApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postAiRemote-connections();

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AiApi(client).post_ai_remote-connections()

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

resp, _, err := client.AiAPI.PostAiRemote-connections(context.Background()).Execute()
if err != nil {
	return err
}

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

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

let result = ai_api::post_ai_remote-connections(&cfg, Default::default()).await?;

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

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

var result = new AiApi(client).postAiRemote-connections();

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 -X POST https://api.hanzo.ai/v1/ai/remote-connections \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP declares no tool for ai — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.

AI API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousStop remote connections NextCreate artifact meta