Upload a photo
Adds a photo to the library: multipart/form-data with the photo in the part file (JPEG, PNG, WebP or HEIC, up to
60 MB; the bytes decide the format, not the declared type). The same photo uploaded again returns the photo already in the
library. The free plan holds a limited number of photos; beyond it the PRO plan is needed (403 PLAN_REQUIRED). A
replay under the same Idempotency-Key with the same file returns the first answer; another file under that key is
422. A file over the limit is 413 FILE_TOO_LARGE; an empty file or one that is not a readable image is 400, field: file. Requires the storefront:write scope and an
Idempotency-Key header.
ApiKeyAuth storefront:writeAuthorizationBearer <shyni_sk_live_*>An API key, issued once and never retrievable again: an organization key in the developer
portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....
Scope: storefront:write
Idempotency-Key*stringCaller-chosen idempotency token for this write. A retry under the SAME key with
the SAME body replays the first response; the SAME key with a DIFFERENT body is
422 IDEMPOTENCY_KEY_MISMATCH. See Idempotency above.
length <= 64multipart/form-data- body
file*filebinaryThe photo in the library.
application/json- response
A photo of the studio's library. Its id is what the storefront and service endpoints point at.
id*stringalt*string|nullwidth*integerheight*integeroriginalFilename*stringcreatedAt*stringdate-timetone*|Whether the photo is mostly light or dark, null when it was not measured.
"LIGHT""DARK"nullfocalPoint*|nullvariants*array<>The sizes of the photo, smallest first.
curl -X POST 'https://api.shyni.io/api/v1/images' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \ -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \ -F 'file=string'Response 201
The photo in the library.
{ "id": "string", "alt": "string", "width": 0, "height": 0, "originalFilename": "string", "createdAt": "2019-08-24T14:15:22Z", "tone": "LIGHT", "focalPoint": { "x": 0, "y": 0 }, "variants": [ { "key": "string", "url": "string", "width": 0, "height": 0 } ]}Response 400
A parameter, header or request body is missing, malformed, or out of range. A request body property the endpoint does not define answers UNKNOWN_FIELD instead, with field naming it.
{ "code": "INVALID_INPUT", "message": "Parameter perPage must be between 1 and 100."}Response 401
Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).
{ "code": "INVALID_API_KEY", "message": "Missing or invalid API key."}Response 403
The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the
permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys,
Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio.
See Authentication and Scopes above.
{ "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the permission this endpoint requires."}Response 413
The file is larger than the upload limit.
{ "code": "string", "message": "string", "field": "string"}Response 422
The same Idempotency-Key was already used for a request with a different body, use a new key (see Idempotency above).
{ "code": "IDEMPOTENCY_KEY_MISMATCH", "message": "This Idempotency-Key was already used for a different request. Use a new key."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}