# List blueprint

URL: https://docs.hanzo.ai/docs/openapi/blueprint/get-blueprint

> Returns every deployable blueprint with its service count and estimated monthly compute cost.

`GET /v1/blueprint`

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

|               |                                        |
| ------------- | -------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/blueprint`    |
| **Method**    | `GET`                                  |
| **Operation** | `get_blueprint`                        |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY` |

Returns every deployable blueprint with its service count and estimated
monthly compute cost.

It is the lightweight index the console renders as a template gallery before
drilling into one stack's bill of images — GET /v1/blueprint/sbom?template=\<id>
is the detail view. The cost is the same figure the deploy path meters the
deploying org on and the 20% author royalty is taken from, priced from the
active rate card (GET /v1/blueprint/health echoes that card).

## Request

`GET /v1/blueprint` takes no parameters and no body — the credential is the whole request.

## Response

| Status    | Body                     | Meaning |
| --------- | ------------------------ | ------- |
| `200`     | blueprint.blueprintIndex | ok      |
| `default` | problem-details          | refused |

`200` body — 4 fields.

| Field                     | In   | Type                      | Always | Description                                                                                                                                             |
| ------------------------- | ---- | ------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data`                    | body | blueprint.blueprintRow\[] | —      | Data is one row per embedded blueprint, sorted by template id.                                                                                          |
| `data[].estCentsPerMonth` | body | integer (int64)           | —      | CentsPerMonth is the estimated compute cost of running the whole stack for one month, in USD cents, from the rate card GET /v1/blueprint/health echoes. |
| `data[].services`         | body | integer (int64)           | —      | Services is how many compose services the stack runs.                                                                                                   |
| `data[].templateId`       | body | string                    | —      | TemplateID is the blueprint slug — the id GET /v1/blueprint/sbom takes as ?template= and the path under templates.hanzo.ai/blueprints/\<id>/.           |

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

## Examples

**CLI**

```bash
hanzo blueprint get
```

**SDK**

**.ts**

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

const api = new BlueprintApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getBlueprint();
```

**.py**

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = BlueprintApi(client).get_blueprint()
```

**.go**

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

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

**.rs**

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

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

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

**.java**

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

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

var result = new BlueprintApi(client).getBlueprint();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/blueprint \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

MCP reaches **blueprint** through the `blueprint` tool, which names its 2 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_blueprints"
         }
       }
     }'
```

---

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