Create device

Begins a device sign-in and returns the code to show the user plus how to poll for completion.

POST /v1/connection/{provider}/device

Provider → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/connection/{provider}/device`
Method	`POST`
Operation	`post_connection_by_provider_device`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Begins a device sign-in and returns the code to show the user plus how to poll for completion. KMS readiness is checked NOW rather than dead-ending the user at poll-done (connect() parity), and the per-provider connector cap is checked before the provider is called. The provider's device code is persisted only in the encrypted grants table and is NEVER returned.

Request

3 fields, body application/json (required).

Field	In	Type	Required	Description
`provider`	path	string	yes	Provider is the user-scoped provider's registry id, from the path.
`label`	body	string	—	Label names this connection so one user can hold several per provider ("work", "personal").
`provider`	body	string	—	Provider is the user-scoped provider's registry id, from the path.

Response

Status	Body	Meaning
`200`	provider.deviceStartOut	ok
`default`	problem-details	refused

200 body — 5 fields.

Field	In	Type	Always	Description
`expiresAt`	body	string	—	ExpiresAt is when the flow dies, RFC 3339 UTC.
`flow`	body	string	—	Flow is the id to poll with.
`interval`	body	integer (int64)	—	Interval is the seconds to wait between polls.
`userCode`	body	string	—	UserCode is the short code the user types at VerifyURL.
`verifyUrl`	body	string	—	VerifyURL is the page the user opens to enter UserCode.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo connection device create <provider>

.ts

.py

.go

.rs

.java

import { Configuration, ProviderApi } from 'hanzoai';

const api = new ProviderApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postConnectionByProviderDevice({ provider: 'provider', label: "<label>", provider: "<provider>" });

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProviderApi(client).post_connection_by_provider_device(provider='provider', label="<label>", provider="<provider>")

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

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

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

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

let result = provider_api::post_connection_by_provider_device(&cfg, Default::default()).await?;

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

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

var result = new ProviderApi(client).postConnectionByProviderDevice();

curl -X POST https://api.hanzo.ai/v1/connection/<provider>/device \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "label": "<label>",
       "provider": "<provider>"
     }'

MCP reaches provider through the provider tool, which names its 38 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": "list_connections"
         }
       }
     }'

Provider API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousCreate poll NextConnect provider