# Project URL: https://docs.hanzo.ai/docs/openapi/project > Where your sites live: create one, deploy a build, roll back to any release. Also for this capability: **API** · [CLI](https://docs.hanzo.ai/docs/cli/project) · [MCP](https://docs.hanzo.ai/docs/mcp-tools/project) · [SDKs](https://docs.hanzo.ai/docs/sdks) Where your sites live: create one, deploy a build, roll back to any release. > [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides) | | | | -------------- | -------------------------------------- | | **Base URL** | `https://api.hanzo.ai` | | **Operations** | 57 | | **Auth** | `Authorization: Bearer $HANZO_API_KEY` | ## Specification Specification pending — no HIP in [hanzoai/hips](https://github.com/hanzoai/hips) declares `capability: project` yet. What this capability serves is below, from the API document; what it is — the store it owns, how it meters, what it publishes — is written as a HIP under HIP-0139. ## Four surfaces | Surface | Reaches this capability as | Coverage | | -------- | ----------------------------------------------- | --------------------------------------------------------- | | **REST** | `project` at its own prefix | 57 operations | | **CLI** | `hanzo project …` | 57 of 57 | | **SDK** | `ProjectApi` in every published client | 29 of 57 — the clients are generated at their own release | | **MCP** | tool `project` on `https://api.hanzo.ai/v1/mcp` | 52 operations | ## Quickstart ```bash export HANZO_API_KEY=sk-... # console.hanzo.ai → API keys ``` Then the first call — a read that needs nothing but the key. `GET /v1/project`, operation `get_project`: **CLI** ```bash hanzo project list ``` **SDK** **.ts** ```ts import { Configuration, ProjectApi } from 'hanzoai'; const api = new ProjectApi(new Configuration({ accessToken: process.env.HANZO_API_KEY })); const { data } = await api.getProject(); ``` **.py** ```python from hanzoai.cloud import ApiClient, Configuration from hanzoai.cloud.api import ProjectApi client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"])) result = ProjectApi(client).get_project() ``` **.go** ```go cfg := hanzoai.NewConfiguration() cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY")) client := hanzoai.NewAPIClient(cfg) resp, _, err := client.ProjectAPI.GetProject(context.Background()).Execute() if err != nil { return err } ``` **.rs** ```rust use hanzo_client::apis::{configuration::Configuration, project_api}; let mut cfg = Configuration::new(); cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok(); let result = project_api::get_project(&cfg, Default::default()).await?; ``` **.java** ```java import ai.hanzo.cloud.ApiClient; import ai.hanzo.cloud.api.ProjectApi; ApiClient client = new ApiClient(); client.setBearerToken(System.getenv("HANZO_API_KEY")); var result = new ProjectApi(client).getProject(); ``` **HTTP** ```bash curl https://api.hanzo.ai/v1/project \ -H "Authorization: Bearer $HANZO_API_KEY" ``` **MCP** Tool `project`, op `get_project` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`. ```bash curl -X POST https://api.hanzo.ai/v1/mcp \ -H "Authorization: Bearer $HANZO_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": { "name": "project", "arguments": { "op": "get_project", "input": {} } } }' ``` Answers `200` with `project.projectsProject[]` — ok. ## Endpoints | Endpoint | What it does | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`POST /v1/project/{slug}/deploy`](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-deploy) | Upload a built site as one archive and serve it | | [`POST /v1/project/{slug}/deployments/{id}/complete`](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-deployments-by-id-complete) | The CI completion hook that flips a queued git deployment to live (or error) once CI has synced the built site to S3. | | [`GET /v1/project/{slug}/deployments/{id}`](https://docs.hanzo.ai/docs/openapi/project/get-project-by-slug-deployments-by-id) | Returns one deployment of a project by id. | | [`GET /v1/project/{slug}/deployments`](https://docs.hanzo.ai/docs/openapi/project/get-project-by-slug-deployments) | Returns a project's deploy history, newest version first. | | [`POST /v1/project/{slug}/deployments`](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-deployments) | Opens a deployment and hands back a short-lived, prefix-scoped grant to write its bytes straight to object storage. | | [`POST /v1/project/{slug}/domains/{host}/verify`](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-domains-by-host-verify) | Checks the DNS challenge for a pending custom hostname and, when it passes, promotes the host so it begins routing at the edge. | | [`DELETE /v1/project/{slug}/domains/{host}`](https://docs.hanzo.ai/docs/openapi/project/delete-project-by-slug-domains-by-host) | Gives a custom hostname back, so the name is free to reuse. | | [`GET /v1/project/{slug}/domains`](https://docs.hanzo.ai/docs/openapi/project/get-project-by-slug-domains) | Returns every custom hostname this site holds: the live ones, plus any pending claim with the DNS records it still owes. | | [`POST /v1/project/{slug}/domains`](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-domains) | Attaches one or more CUSTOM public hostnames to this org's site. | | [`POST /v1/project/{slug}/publish`](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-publish) | Promotes a build output into a new release AND goes live with it — create+activate in one call, which is the 99% path. | | [`POST /v1/project/{slug}/purge`](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-purge) | Flushes the site's edge cache without redeploying anything. | | [`POST /v1/project/{slug}/releases/{release}/activate`](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-releases-by-release-activate) | Points the site at an existing release — the go-live, and equally the ROLLBACK. | | [`GET /v1/project/{slug}/releases`](https://docs.hanzo.ai/docs/openapi/project/get-project-by-slug-releases) | Returns a site's releases newest-first, marking the active one — the rollback menu. | | [`POST /v1/project/{slug}/releases`](https://docs.hanzo.ai/docs/openapi/project/post-project-by-slug-releases) | Promotes a build output into a new immutable release WITHOUT serving it — the staged half of publishing, for when you want to check a release before it goes live. | | [`GET /v1/project/{slug}/shot`](https://docs.hanzo.ai/docs/openapi/project/get-project-by-slug-shot) | Get a PNG of the project's live site | | [`PUT /v1/project/{slug}/star`](https://docs.hanzo.ai/docs/openapi/project/put-project-by-slug-star) | Bookmarks a project for the person calling, and answers whether it is starred afterwards. | | [`DELETE /v1/project/{slug}/star`](https://docs.hanzo.ai/docs/openapi/project/delete-project-by-slug-star) | Removes the caller's own bookmark from a project, and answers whether it is starred afterwards. | | [`GET /v1/project/{slug}`](https://docs.hanzo.ai/docs/openapi/project/get-project-by-slug) | Returns one project of yours by slug — its settings, its live URL and the deployment currently serving it. | | [`PATCH /v1/project/{slug}`](https://docs.hanzo.ai/docs/openapi/project/patch-project-by-slug) | Changes a project's settings, and only the settings you send. | | [`DELETE /v1/project/{slug}`](https://docs.hanzo.ai/docs/openapi/project/delete-project-by-slug) | Deletes a project and takes its site off the internet. | | [`GET /v1/project/edge`](https://docs.hanzo.ai/docs/openapi/project/get-project-edge) | health reports whether a publish reaches readers, rather than whether it was accepted. | | [`POST /v1/project/fork`](https://docs.hanzo.ai/docs/openapi/project/post-project-fork) | Creates a project seeded from a PUBLISHED EXAMPLE — either a starter-kit template from the ONE embedded gallery catalog, or any live project on the platform (an example a seeded creator published, or another org's app serving at \.hanzo.app). | | [`GET /v1/project/sites/{slug}`](https://docs.hanzo.ai/docs/openapi/project/get-project-sites-by-slug) | Returns one site — the same row ListSites carries, for one slug. | | [`POST /v1/project/sites/deploy`](https://docs.hanzo.ai/docs/openapi/project/post-project-sites-deploy) | Deploys a caller-supplied file manifest — the deploy\_site capability an agent calls — and answers with where it went live. | | [`GET /v1/project/sites`](https://docs.hanzo.ai/docs/openapi/project/get-project-sites) | Returns the org's deployed sites at the pretty URLs they serve at. | | [`POST /v1/project/sites`](https://docs.hanzo.ai/docs/openapi/project/post-project-sites) | Generates a self-contained, mobile-responsive static site from a natural-language brief and deploys it live in one call. | | [`GET /v1/project/tags`](https://docs.hanzo.ai/docs/openapi/project/get-project-tags) | The site's browser tag set for the hosted tag — which pixels to inject, by publishable key | | [`GET /v1/project`](https://docs.hanzo.ai/docs/openapi/project/get-project) | Returns every project your org owns. | | [`POST /v1/project`](https://docs.hanzo.ai/docs/openapi/project/post-project) | Creates a project — the handle a site is deployed and served under — and answers 201 with it in `draft`. | | [`POST /v1/projects/{slug}/deploy`](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-deploy) | Upload a built site as one archive and serve it | | [`POST /v1/projects/{slug}/deployments/{id}/complete`](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-deployments-by-id-complete) | The CI completion hook that flips a queued git deployment to live (or error) once CI has synced the built site to S3. | | [`GET /v1/projects/{slug}/deployments/{id}`](https://docs.hanzo.ai/docs/openapi/project/get-projects-by-slug-deployments-by-id) | Returns one deployment of a project by id. | | [`GET /v1/projects/{slug}/deployments`](https://docs.hanzo.ai/docs/openapi/project/get-projects-by-slug-deployments) | Returns a project's deploy history, newest version first. | | [`POST /v1/projects/{slug}/deployments`](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-deployments) | Opens a deployment and hands back a short-lived, prefix-scoped grant to write its bytes straight to object storage. | | [`POST /v1/projects/{slug}/domains/{host}/verify`](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-domains-by-host-verify) | Checks the DNS challenge for a pending custom hostname and, when it passes, promotes the host so it begins routing at the edge. | | [`DELETE /v1/projects/{slug}/domains/{host}`](https://docs.hanzo.ai/docs/openapi/project/delete-projects-by-slug-domains-by-host) | Gives a custom hostname back, so the name is free to reuse. | | [`GET /v1/projects/{slug}/domains`](https://docs.hanzo.ai/docs/openapi/project/get-projects-by-slug-domains) | Returns every custom hostname this site holds: the live ones, plus any pending claim with the DNS records it still owes. | | [`POST /v1/projects/{slug}/domains`](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-domains) | Attaches one or more CUSTOM public hostnames to this org's site. | | [`POST /v1/projects/{slug}/publish`](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-publish) | Promotes a build output into a new release AND goes live with it — create+activate in one call, which is the 99% path. | | [`POST /v1/projects/{slug}/purge`](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-purge) | Flushes the site's edge cache without redeploying anything. | | [`POST /v1/projects/{slug}/releases/{release}/activate`](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-releases-by-release-activate) | Points the site at an existing release — the go-live, and equally the ROLLBACK. | | [`GET /v1/projects/{slug}/releases`](https://docs.hanzo.ai/docs/openapi/project/get-projects-by-slug-releases) | Returns a site's releases newest-first, marking the active one — the rollback menu. | | [`POST /v1/projects/{slug}/releases`](https://docs.hanzo.ai/docs/openapi/project/post-projects-by-slug-releases) | Promotes a build output into a new immutable release WITHOUT serving it — the staged half of publishing, for when you want to check a release before it goes live. | | [`GET /v1/projects/{slug}/shot`](https://docs.hanzo.ai/docs/openapi/project/get-projects-by-slug-shot) | Get a PNG of the project's live site | | [`PUT /v1/projects/{slug}/star`](https://docs.hanzo.ai/docs/openapi/project/put-projects-by-slug-star) | Bookmarks a project for the person calling, and answers whether it is starred afterwards. | | [`DELETE /v1/projects/{slug}/star`](https://docs.hanzo.ai/docs/openapi/project/delete-projects-by-slug-star) | Removes the caller's own bookmark from a project, and answers whether it is starred afterwards. | | [`GET /v1/projects/{slug}`](https://docs.hanzo.ai/docs/openapi/project/get-projects-by-slug) | Returns one project of yours by slug — its settings, its live URL and the deployment currently serving it. | | [`PATCH /v1/projects/{slug}`](https://docs.hanzo.ai/docs/openapi/project/patch-projects-by-slug) | Changes a project's settings, and only the settings you send. | | [`DELETE /v1/projects/{slug}`](https://docs.hanzo.ai/docs/openapi/project/delete-projects-by-slug) | Deletes a project and takes its site off the internet. | | [`GET /v1/projects/edge`](https://docs.hanzo.ai/docs/openapi/project/get-projects-edge) | health reports whether a publish reaches readers, rather than whether it was accepted. | | [`POST /v1/projects/fork`](https://docs.hanzo.ai/docs/openapi/project/post-projects-fork) | Creates a project seeded from a PUBLISHED EXAMPLE — either a starter-kit template from the ONE embedded gallery catalog, or any live project on the platform (an example a seeded creator published, or another org's app serving at \.hanzo.app). | | [`GET /v1/projects/sites/{slug}`](https://docs.hanzo.ai/docs/openapi/project/get-projects-sites-by-slug) | Returns one site — the same row ListSites carries, for one slug. | | [`POST /v1/projects/sites/deploy`](https://docs.hanzo.ai/docs/openapi/project/post-projects-sites-deploy) | Deploys a caller-supplied file manifest — the deploy\_site capability an agent calls — and answers with where it went live. | | [`GET /v1/projects/sites`](https://docs.hanzo.ai/docs/openapi/project/get-projects-sites) | Returns the org's deployed sites at the pretty URLs they serve at. | | [`POST /v1/projects/sites`](https://docs.hanzo.ai/docs/openapi/project/post-projects-sites) | Generates a self-contained, mobile-responsive static site from a natural-language brief and deploys it live in one call. | | [`GET /v1/projects`](https://docs.hanzo.ai/docs/openapi/project/get-projects) | Returns every project your org owns. | | [`POST /v1/projects`](https://docs.hanzo.ai/docs/openapi/project/post-projects) | Creates a project — the handle a site is deployed and served under — and answers 201 with it in `draft`. | --- [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)