# Update documents

URL: https://docs.hanzo.ai/docs/openapi/studio/patch-studio-documents-by-id

> Changes one of your documents; absent fields stay as they are.

`PATCH /v1/studio/documents/{id}`

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

|               |                                                 |
| ------------- | ----------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/studio/documents/{id}` |
| **Method**    | `PATCH`                                         |
| **Operation** | `patch_studio_documents_by_id`                  |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`          |

Changes one of your documents; absent fields stay as they are.

## Request

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

| Field           | In   | Type      | Required | Description |
| --------------- | ---- | --------- | -------- | ----------- |
| `id`            | path | string    | yes      |             |
| `brand`         | body | string    | —        |             |
| `id`            | body | string    | —        |             |
| `ir`            | body | studio.IR | —        |             |
| `ir.blocks`     | body | object\[] | —        |             |
| `ir.blocks[].*` | body | any       | —        |             |
| `ir.slides`     | body | object\[] | —        |             |
| `ir.slides[].*` | body | any       | —        |             |
| `shared`        | body | boolean   | —        |             |
| `title`         | body | string    | —        |             |

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | studio.Document | ok      |
| `default` | problem-details | refused |

`200` body — 14 fields.

| Field           | In   | Type      | Always | Description |
| --------------- | ---- | --------- | ------ | ----------- |
| `brand`         | body | string    | —      |             |
| `created`       | body | string    | —      |             |
| `creator`       | body | string    | —      |             |
| `id`            | body | string    | —      |             |
| `ir`            | body | studio.IR | —      |             |
| `ir.blocks`     | body | object\[] | —      |             |
| `ir.blocks[].*` | body | any       | —      |             |
| `ir.slides`     | body | object\[] | —      |             |
| `ir.slides[].*` | body | any       | —      |             |
| `kind`          | body | string    | —      |             |
| `org`           | body | string    | —      |             |
| `shared`        | body | boolean   | —      |             |
| `title`         | body | string    | —      |             |
| `updated`       | body | string    | —      |             |

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

## Examples

**CLI**

```bash
hanzo studio documents update <id>
```

**SDK**

**.ts**

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

const api = new StudioApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.patchStudioDocumentsById({ id: 'id', brand: "<brand>", id: "<id>" });
```

**.py**

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = StudioApi(client).patch_studio_documents_by_id(id='id', brand="<brand>", id="<id>")
```

**.go**

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

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

**.rs**

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

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

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

**.java**

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

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

var result = new StudioApi(client).patchStudioDocumentsById();
```

**HTTP**

```bash
curl -X PATCH https://api.hanzo.ai/v1/studio/documents/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "brand": "<brand>",
       "id": "<id>"
     }'
```

**MCP**

MCP reaches **studio** through the `studio` tool, which names its 32 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_studio_brands"
         }
       }
     }'
```

---

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