memory

The picture we hold for an image memory

The only call on this plane that answers with something other than JSON: the stored image itself, with its own Content-Type. Not necessarily your upload — anything over 1568px on its long edge (2500px at most) was stored downscaled, and re-encoded to WebP unless it was a JPEG or the re-encode came out bigger, so a PNG usually comes back as image/webp. When the format changed, x-wos-image-converted-from names what you sent; take the file extension from Content-Type rather than from your upload. A memory that exists but carries no image is a 404, same as an unknown id.

post/api/v1/memory/image

Request

  • Base URL: https://api.wontopos.com
  • URL: https://api.wontopos.com/api/v1/memory/image
  • Auth: API key in header X-API-Key

Headers

X-WOS-Modelstring

Which engine reads the memory (see GET /api/v1/models). All live models share one memory per workspace, so you can store with one and recall with another. A retired model answers 410 with error.type gone_error and error.code 0, except on DELETE /api/v1/memory/collection, which deletes the store under any model. Until then, a model scheduled to retire names the day in a Sunset header (RFC 8594) on every answer it serves, the same date GET /api/v1/models lists as retires_at.

Request body

user_idstring required

The store to operate on. Stores are explicit: create one first or use the built-in "default". Use the id the store was created with: 1-64 ASCII letters, digits, ., _ or -, starting with a letter or digit. Ids that differ only by case name one store.

memory_idstring uuid required

The memory whose image you want.

Response

The image bytes as we hold them — downscaled to 1568px on the long edge when it was longer, and re-encoded to WebP unless it was a JPEG or that came out bigger. Content-Type is sniffed from the bytes; x-wos-image-converted-from appears when the format changed.

Changes

No recorded changes to this operation across all 1 revision of this API.