Retrieve an image's metadata
Metadata and embedding status of an uploaded image.
Операция для полного ключа
Metadata and embedding status of an uploaded image.
Authorization
api_key_header Every request carries an organization API key. A key has one of two scopes. A full key reaches every operation in this document and belongs on your server. A search key is the one to ship in a browser widget or a storefront page: it reaches only the operations marked x-nova-key-scope: search — searching, federated search, recommendations, event ingestion, and the visitor-facing AI operations (semantic and image search, voice transcription and voice search, assistant chat, and the visitor's own conversation). It cannot write documents or read or change configuration; any other operation answers 403. AI operations are paid in credits from the organization's wallet whichever key calls them (402 when the balance runs out), and a search key needs X-NOVA-SESSION-ID on them: the session is what a conversation belongs to, and what the per-session allowance (429) is counted against. A key of either scope may additionally carry restrictions set in the console: an allowlist of collections (403 elsewhere), a forced filter_by per collection that is ANDed into every search (document-level access control), an allowlist of fields (include_fields is limited to it and a request naming any other field in query_by, facet_by, sort_by, filter_by or highlight_fields answers 400), an IP/CIDR allowlist and an Origin/Referer allowlist (403), and a per-key rate limit (429 with Retry-After).
In: header
Path Parameters
The id of the media asset
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/media/string"{ "media_id": "string", "mime": "string", "bytes": 0, "uploaded": true, "caption": "string", "embedding": { "status": "pending", "model": "string", "num_dim": 0, "error": "string" }, "collection": "string", "document_id": "string", "vector_field": "string", "created_at": 0}Upload an image POST
Stores an image (PNG, JPEG, WebP or GIF, up to 8 MB) and computes its embedding in the background: the image is described by a vision model and the description is embedded with the same multilingual text model used by `createEmbeddings`, so text queries in any language and other images land in one vector space. Pass `collection`, `document_id` and `vector_field` to have the embedding written into that document (the field must be a `float[]` with `num_dim: 1024`); the description is written into `caption_field` when given. Poll `getMedia` until `embedding.status` is `ready`.
Delete an image DELETE
Deletes the stored image and its metadata. Vectors already written into documents stay.