# Rename an asset

Source: https://kirora.io/docs/api/reference/updateAsset

`PATCH /v1/assets/{id}`

Requires an API key with the `templates:write` scope. [About keys and scopes](https://kirora.io/docs/api/reference/authentication)

Works with integration, agent and partner keys.

Safe to retry: a repeat sets the same values again. [About idempotency](https://kirora.io/docs/api/reference/idempotency)

Changes the name the library shows. The file, its `filename` and its `url` stay as they are, so emails using it are unaffected.

## Path parameters

- `id` (string, required, uuid) — The asset's id.

## Header parameters

- `Kirora-Workspace` (string, optional, pattern `^[A-Za-z0-9._:-]{1,128}$`) — Partner keys only: the child workspace to act in, by the external id the partner gave it. Without it, a partner key acts in its own workspace. Any other key that sends it is refused with 403, and an unknown workspace is 404.

## Request body

- `name` (string, required, 1–200 characters) — The name the library shows.

## Returns

Returns `200 OK` with an `Asset` in `data`. It can also return `409 Conflict`, `413 Payload Too Large` or `415 Unsupported Media Type`; see the statuses below. Otherwise returns an error; [Errors](https://kirora.io/docs/api/reference/errors) lists every code and which to retry.

- `id` (string, required, uuid)
- `type` (string, required, one of `image`) — The kind of file: `image`. More kinds, such as `video`, may be added: branch on `type` and keep the ones you do not know.
- `name` (string, required) — The name the library shows.
- `filename` (string, required) — The file's name as uploaded or copied.
- `url` (string, required, uri) — The file's public address, such as an image `src`.
- `mimeType` (string, required, one of `image/png`, `image/jpeg`, `image/gif`) — The file's format.
- `sizeBytes` (integer, required, min > 0) — File size in bytes.
- `width` (integer, required, min > 0) — The file's width in px.
- `height` (integer, required, min > 0) — The file's height in px.
- `createdAt` (string, required, date-time)

Statuses:

- `200 OK`: The renamed asset.
- `409 Conflict`: The request conflicts with current state — a duplicate unique value, or a resource whose status does not allow this operation.
- `413 Payload Too Large`: The body is larger than this operation accepts (`PAYLOAD_TOO_LARGE`).
- `415 Unsupported Media Type`: The body is not JSON, or not the upload the operation takes (`UNSUPPORTED_MEDIA_TYPE`).

## Example: Rename it in the library; its address stays

```bash
curl -X PATCH https://api.kirora.io/v1/assets/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme logo, dark"
  }'
```

Response `200`:

```json
{
  "data": {
    "id": "0192f3d2-4d5e-7f60-9b72-8d9e0f1a2b3c",
    "type": "image",
    "name": "Acme logo, dark",
    "filename": "acme-logo.png",
    "url": "https://assets.kirora.io/images/0192f3d2-4d5e-7f60-9b72-8d9e0f1a2b3c.png",
    "mimeType": "image/png",
    "sizeBytes": 18432,
    "width": 600,
    "height": 200,
    "createdAt": "2026-10-01T09:30:00.000Z"
  }
}
```