Update library

Renames one of your items, shares it with your organization or stops sharing it, moves it to a project, or commits a reserved upload.

PATCH /v1/library/{id}

Library → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/library/{id}`
Method	`PATCH`
Operation	`patch_library_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Renames one of your items, shares it with your organization or stops sharing it, moves it to a project, or commits a reserved upload. Only its owner changes an item; a member's shared item answers 404 here as one that does not exist.

Request

6 fields, body application/json (required).

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the item, from the path.
`commit`	body	boolean	—	Commit finishes a reserved upload once its bytes have been PUT.
`id`	body	string	—	ID is the item, from the path.
`name`	body	string	—	Name renames it.
`project`	body	string	—	Project moves it to one of the organization's projects; "" moves it out.
`shared`	body	boolean	—	Shared shows it to every member of your organization, or stops.

Response

Status	Body	Meaning
`200`	library.LibraryItem	ok
`default`	problem-details	refused

200 body — 29 fields.

Field	In	Type	Always	Description
`by`	body	string	—	By is the owner as a reader names them: the name, else the address, the identity boundary carried when the item was made.
`bytes`	body	integer (int64)	—
`created`	body	string	—
`download`	body	string	—
`expires`	body	string	—
`height`	body	integer (int64)	—
`id`	body	string	—
`kind`	body	string	—
`mime`	body	string	—
`mine`	body	boolean	—
`name`	body	string	—
`origin`	body	string	—
`owner`	body	string	—
`pages`	body	integer (int64)	—
`preview`	body	string	—
`project`	body	string	—
`ref`	body	string	—
`seconds`	body	number (double)	—
`shared`	body	boolean	—
`source`	body	string	—
`updated`	body	string	—
`upload`	body	library.LibraryUpload	—
`upload.expires`	body	string	—
`upload.headers`	body	library.Field[]	—	Headers are the ones the PUT must carry.
`upload.headers[].name`	body	string	—	Name is the field's name.
`upload.headers[].value`	body	string	—	Value is the field's value, verbatim.
`upload.url`	body	string	—
`url`	body	string	—
`width`	body	integer (int64)	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo library update <id>

.ts

.py

.go

.rs

.java

import { Configuration, LibraryApi } from 'hanzoai';

const api = new LibraryApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.patchLibraryById({ id: 'id', commit: false, id: "<id>" });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import LibraryApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = LibraryApi(client).patch_library_by_id(id='id', commit=False, id="<id>")

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

resp, _, err := client.LibraryAPI.PatchLibraryById(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, library_api};

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

let result = library_api::patch_library_by_id(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.LibraryApi;

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

var result = new LibraryApi(client).patchLibraryById();

curl -X PATCH https://api.hanzo.ai/v1/library/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "commit": false,
       "id": "<id>"
     }'

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

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_libraries"
         }
       }
     }'

Library API · All Hanzo APIs · Interactive reference

Was this page useful?

Broken link or missing step? Drop it in #docs on Discord or open a PR.

PreviousList library NextCreate library