nips/29.md
2024-02-01 13:09:24 -08:00

44 lines
1.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

NIP029
======
imeta
--------------
`imeta` is a tag for adding media attachments to events. `imeta` tags MUST match URLs
in the event content. Clients may replace imeta URLs with rich previews. `imeta` tags
contain extra information about the media attachment, which clients can use to provide
a better experience when loading images.
The `imeta` tag is variadic, and each entry is a space-delimited key/value pair.
Each `imeta` tag MUST have a `url`, and at least one other field. `imeta` may include
any field specified by [NIP 94](./94.md). There SHOULD be only one `imeta` tag per url.
## Example
```json
{
"content": "More image metadata tests dont mind me https://nostr.build/i/my-image.jpg",
"kind": 1,
"tags": [
[
"imeta",
"url https://nostr.build/i/my-image.jpg",
"blurhash eVF$^OI:${M{o#*0-nNFxakD-?xVM}WEWB%iNKxvR-oetmo#R-aen$",
"dim 3024x4032",
"alt A scenic photo overlooking the coast of Costa Rica",
"x <sha256 hash as specified in NIP 94>",
"fallback https://nostrcheck.me/alt1.jpg"
"fallback https://void.cat/alt1.jpg"
]
]
}
```
## Recommended client behavior
When uploading images during a new post, clients MAY include this metadata
after the image is uploaded and included in the post.
When pasting urls during post composition, the client MAY download the image
and add this metadata before the post is sent.