OpenapiSync
Run reconciles one sync now — the manual re-sync, and the initial import for a…
Run reconciles one sync now — the manual re-sync, and the initial import for a link created without run=true.
POST /v1/sync/{id}/run
| Address | https://api.hanzo.ai/v1/sync/{id}/run |
| Method | POST |
| Operation | post_sync_by_id_run |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Run reconciles one sync now — the manual re-sync, and the initial import for a link created without run=true. The work is handed to a bounded background worker and the call answers 202 immediately, so a large mirror-in never holds the request open; queued=true means accepted, not finished.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the sync to act on, from the path. |
Response
| Status | Body | Meaning |
|---|---|---|
202 | syncQueued | accepted |
202 body — 2 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
id | body | string | — | ID is the sync the reconcile was queued for. |
queued | body | boolean | — | Queued is true when the reconcile was accepted; it has not run yet. |
Failure carries the platform error shape — see Errors.
Examples
hanzo sync run <id>import { Configuration, SyncApi } from 'hanzoai';
const api = new SyncApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postSyncByIdRun({ id: 'id' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import SyncApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = SyncApi(client).post_sync_by_id_run(id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.SyncAPI.PostSyncByIdRun(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, sync_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = sync_api::post_sync_by_id_run(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.SyncApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new SyncApi(client).postSyncByIdRun();curl -X POST https://api.hanzo.ai/v1/sync/<id>/run \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches sync through the sync tool, which names its 6 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_sync"
}
}
}'How is this guide?