# Replace template

URL: https://docs.hanzo.ai/docs/openapi/template/put-template-by-slug

> Overwrites the caller org's OWN starter kit at the path slug, answering the stored kit.

`PUT /v1/template/{slug}`

> [Template →](https://docs.hanzo.ai/docs/openapi/template) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                           |
| ------------- | ----------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/template/{slug}` |
| **Method**    | `PUT`                                     |
| **Operation** | `put_template_by_slug`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`    |

Overwrites the caller org's OWN starter kit at the path slug, answering
the stored kit. A slug they do not own is 404, never a create: the UPDATE binds
org, so a PUT can never reach another org's kit.

## Request

17 fields, body `application/json` (required).

| Field                  | In   | Type                | Required | Description                                                                                        |
| ---------------------- | ---- | ------------------- | -------- | -------------------------------------------------------------------------------------------------- |
| `slug`                 | path | string              | yes      | Slug is the kit to replace, from the path.                                                         |
| `category`             | body | string              | —        | Category groups the kit in the gallery browser.                                                    |
| `demo`                 | body | string              | —        | Demo is the deployed site itself, when there is one.                                               |
| `description`          | body | string              | —        | Description is the browse-card blurb, max 4096 characters.                                         |
| `features`             | body | string\[]           | —        | Features are the highlights the card lists, at most 32.                                            |
| `framework`            | body | string              | —        | Framework is the stack the kit is built on ("Next.js 14").                                         |
| `preview`              | body | string              | —        | Preview is the still image the browse card renders, max 4096 characters.                           |
| `slug`                 | body | string              | —        | Slug is the kit to replace, from the path.                                                         |
| `source`               | body | string              | —        | Source is the repository the kit is forked from, max 4096 characters.                              |
| `title`                | body | string              | —        | Title is the display name.                                                                         |
| `useCase`              | body | string              | —        | UseCase is what the kit is for, in a phrase.                                                       |
| `variants`             | body | template.Variant\[] | —        | Variants are the shapes this kit ships in, at most 32; the fork picks one.                         |
| `variants[].framework` | body | string              | —        | only when it differs from the template's                                                           |
| `variants[].id`        | body | string              | —        | selector, unique within the template ("react", "grid-3-fluid")                                     |
| `variants[].kind`      | body | string              | —        | the axis it varies: format \| page \| theme                                                        |
| `variants[].label`     | body | string              | —        | human label for the picker                                                                         |
| `variants[].source`    | body | string              | —        | the repository this shape is forked from; the synthesized default shape carries the template's own |

## Response

| Status    | Body                | Meaning |
| --------- | ------------------- | ------- |
| `200`     | template.StarterKit | ok      |
| `default` | problem-details     | refused |

`200` body — 19 fields.

| Field                  | In   | Type                | Always | Description                                                                                                                                |
| ---------------------- | ---- | ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `category`             | body | string              | —      | groups the kit in the gallery browser ("Portfolio", "SaaS")                                                                                |
| `demo`                 | body | string              | —      | live demo (\<slug>.hanzo.app), when deployed                                                                                               |
| `description`          | body | string              | —      | the browse-card blurb                                                                                                                      |
| `features`             | body | string\[]           | —      | the highlights the card lists, at most 32                                                                                                  |
| `framework`            | body | string              | —      | the stack the kit is built on ("Next.js 14.2 + TS")                                                                                        |
| `org`                  | body | string              | —      | owner of a PRIVATE template; empty in the public catalog                                                                                   |
| `preview`              | body | string              | —      | the still image the browse card renders                                                                                                    |
| `rating`               | body | number (double)     | —      | Rating is public-gallery curation, on the same terms as Tier: catalog-only, never accepted from a request, absent on a customer's own kit. |
| `slug`                 | body | string              | —      | the kit's identity — lowercase alphanumeric with dashes, max 40                                                                            |
| `source`               | body | string              | —      | the repository the kit is forked from                                                                                                      |
| `tier`                 | body | integer (int64)     | —      | Tier is public-gallery curation, carried verbatim from the embedded catalog.                                                               |
| `title`                | body | string              | —      | display name                                                                                                                               |
| `useCase`              | body | string              | —      | what the kit is for, in a phrase                                                                                                           |
| `variants`             | body | template.Variant\[] | —      | the shapes this template ships in                                                                                                          |
| `variants[].framework` | body | string              | —      | only when it differs from the template's                                                                                                   |
| `variants[].id`        | body | string              | —      | selector, unique within the template ("react", "grid-3-fluid")                                                                             |
| `variants[].kind`      | body | string              | —      | the axis it varies: format \| page \| theme                                                                                                |
| `variants[].label`     | body | string              | —      | human label for the picker                                                                                                                 |
| `variants[].source`    | body | string              | —      | the repository this shape is forked from; the synthesized default shape carries the template's own                                         |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo template set <slug>
```

**SDK**

**.ts**

```ts
import { Configuration, TemplateApi } from 'hanzoai';

const api = new TemplateApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putTemplateBySlug({ slug: 'slug', category: "<category>", demo: "<demo>" });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TemplateApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TemplateApi(client).put_template_by_slug(slug='slug', category="<category>", demo="<demo>")
```

**.go**

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

resp, _, err := client.TemplateAPI.PutTemplateBySlug(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, template_api};

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

let result = template_api::put_template_by_slug(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TemplateApi;

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

var result = new TemplateApi(client).putTemplateBySlug();
```

**HTTP**

```bash
curl -X PUT https://api.hanzo.ai/v1/template/<slug> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "category": "<category>",
       "demo": "<demo>"
     }'
```

**MCP**

MCP reaches **template** through the `template` tool, which names its 5 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
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_templates"
         }
       }
     }'
```

---

[Template API](https://docs.hanzo.ai/docs/openapi/template) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
