Create projects
Creates a project from the apps it starts with.
POST /v1/platform/projects
| Address | https://api.hanzo.ai/v1/platform/projects |
| Method | POST |
| Operation | post_platform_projects |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Creates a project from the apps it starts with.
A project is the partOf its apps' values files name, so creating one names it
on the listed apps: one commit to hanzoai/universe that moves each file's
partOf scalar and touches nothing else. There is no empty project; to start
one with a new app, create the app with partOf (POST /v1/platform/apps).
mode is branch (the default: a review branch, nothing deploys) or commit
(main). A partOf change relabels the app's pods, so the sync that applies it
rolls them. 409 when the name already names apps — move apps into an existing
project with PUT /v1/platform/apps/{app}/project. An org admin changes its own
org's projects; the platform's own, and another org's, are SuperAdmin.
Request
6 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
apps | body | platform.declRef[] | — | Apps are the declarations it starts with, each by values directory (org, defaulting to the caller's own) and name. |
apps[].name | body | string | — | Name is the declaration's name, the file's basename. |
apps[].org | body | string | — | Org is the values directory the declaration lives in. |
mode | body | string | — | Mode is branch (the default: a review branch, nothing deploys) or commit (main). |
name | body | string | — | Name is the project, a DNS-1123 label; it becomes each app's partOf. |
org | body | string | — | Org names the project's owner, defaulting to the caller's own scope; naming another is an act-as only a SuperAdmin has. |
Response
| Status | Body | Meaning |
|---|---|---|
201 | platform.projectWrite | created |
default | problem-details | refused |
201 body — 11 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
commit | body | string | — | Commit is the sha the change created, "" when nothing had to move. |
live | body | boolean | — | Live says whether the generator will see it: true only on main. |
mode | body | string | — | Mode is branch (a review; nothing deploys) or commit (main). |
moved | body | platform.relabel[] | — | Moved are the declarations whose partOf moved, and from what. |
moved[].from | body | string | — | |
moved[].name | body | string | — | |
moved[].org | body | string | — | |
moved[].to | body | string | — | |
project | body | string | — | Project is the project the change leaves the moved apps in. |
ref | body | string | — | Ref is the branch the change was pushed to, main for a commit. |
review | body | string | — | Review is where to open the pull request for a branch. |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, PlatformApi } from 'hanzoai';
const api = new PlatformApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postPlatformProjects({ apps: [{"name":"<name>","org":"<org>"}], mode: "<mode>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PlatformApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PlatformApi(client).post_platform_projects(apps=[{"name":"<name>","org":"<org>"}], mode="<mode>")cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.PlatformAPI.PostPlatformProjects(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, platform_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = platform_api::post_platform_projects(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PlatformApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new PlatformApi(client).postPlatformProjects();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/platform/projects \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"apps": [
{
"name": "<name>",
"org": "<org>"
}
],
"mode": "<mode>"
}'MCP reaches platform through the platform tool, which names its 39 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_builds"
}
}
}'How is this guide?