Start a large upload
Registers an image whose bytes will be streamed separately with `putMediaContent` — use it instead of `uploadMedia` for files above a few megabytes (up to 100 MB). The embedding job starts once the bytes arrive. Same targeting fields as `uploadMedia`.
Full-key operation
Registers an image whose bytes will be streamed separately with putMediaContent — use it instead of uploadMedia for files above a few megabytes (up to 100 MB). The embedding job starts once the bytes arrive. Same targeting fields as uploadMedia.
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
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/media/uploads" \ -H "Content-Type: application/json" \ -d '{ "mime": "image/png" }'{ "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}Search a collection by image POST
Finds documents whose `vector_field` is closest to the given image — an uploaded `media_id`, an `image_url`, or inline `image_base64`. The image is embedded the same way uploads are, so results are consistent with `uploadMedia`.
Create a signed download URL POST
Returns a time-limited URL for `getMediaContent` that needs no API key — for `<img src>` in storefronts and emails. Anyone with the URL can fetch the image until it expires.