# Environment

URL: https://docs.hanzo.ai/docs/openapi/environment

> What a codebase is before its agent starts: the commands that install it, the command that starts it, and the secrets it reads.

Also for this capability: **API** · [MCP](https://docs.hanzo.ai/docs/mcp-tools/environment) · [SDKs](https://docs.hanzo.ai/docs/sdks)

What a codebase is before its agent starts: the commands that install it, the command that starts it, and the secrets it reads.

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

|                |                                        |
| -------------- | -------------------------------------- |
| **Base URL**   | `https://api.hanzo.ai`                 |
| **Operations** | 6                                      |
| **Auth**       | `Authorization: Bearer $HANZO_API_KEY` |

## Specification

Specification pending — no HIP in [hanzoai/hips](https://github.com/hanzoai/hips) declares `capability: environment` 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** | `environment` at its own prefix                     | 6 operations                                                              |
| **CLI**  | —                                                   | no command reaches it yet — use HTTP or an SDK                            |
| **SDK**  | `EnvironmentApi` in every published client          | 6 methods                                                                 |
| **MCP**  | tool `environment` on `https://api.hanzo.ai/v1/mcp` | 4 operations, 1 under the document's own id — ask `describe` for the rest |

## 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/environment`, operation `get_environment`:

**CLI**

`hanzo` has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

**SDK**

**.ts**

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

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

**.py**

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

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

**.go**

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

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

**.rs**

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

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

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

**.java**

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

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

var result = new EnvironmentApi(client).getEnvironment();
```

**HTTP**

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

**MCP**

MCP reaches **environment** through the `environment` tool, which names its 4 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_environments"
         }
       }
     }'
```

Answers `200` with `object` — ok.

## Endpoints

| Endpoint                                                                                                                                    | What it does                                                 |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| [`PUT /v1/environment/{repo}/secrets/{name}`](https://docs.hanzo.ai/docs/openapi/environment/put-environment-by-repo-secrets-by-name)       | Sets one secret on a codebase.                               |
| [`DELETE /v1/environment/{repo}/secrets/{name}`](https://docs.hanzo.ai/docs/openapi/environment/delete-environment-by-repo-secrets-by-name) | Removes one secret from a codebase.                          |
| [`GET /v1/environment/{repo}`](https://docs.hanzo.ai/docs/openapi/environment/get-environment-by-repo)                                      | Reads one codebase's environment.                            |
| [`PUT /v1/environment/{repo}`](https://docs.hanzo.ai/docs/openapi/environment/put-environment-by-repo)                                      | Saves one codebase's install and start scripts.              |
| [`DELETE /v1/environment/{repo}`](https://docs.hanzo.ai/docs/openapi/environment/delete-environment-by-repo)                                | Forgets one codebase's environment, and its secrets with it. |
| [`GET /v1/environment`](https://docs.hanzo.ai/docs/openapi/environment/get-environment)                                                     | Lists every codebase in your org that has an environment.    |

---

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