---
title: "Upload an image"
method: POST
path: "/uploads"
---

# Upload an image

`POST /uploads`

## Request

- Base URL: `https://clusters.soleilpictures.com/api/v1`
- URL: `https://clusters.soleilpictures.com/api/v1/uploads`
- Auth: HTTP bearer

The raw bytes go in the body, with Content-Type set to the image type. Returns a key to pass as `image_key` when creating a card. Charged against the board owner's storage, so ?board= is required. 25MB maximum. Pass ?filename= to keep the file's own name: it comes back as `file_name`, to send on the card too.

## Query parameters

- `board` string, uuid, required
- `filename` string

## Response `201`

The stored key, and its dimensions where they could be read

- object
  - `image_key` string
  - `width` integer, nullable
  - `height` integer, nullable
  - `bytes` integer
  - `content_type` string
  - `file_name` string, nullable: The name kept from ?filename=, if any.

## Other responses

- `402`: That would go past the storage included with this account
- `413`: Larger than 25MB
- `415`: Not an image type this API accepts

---

[API](https://skmtc.dev/soleilpictures/apis/soleil-clusters-api.md) · [All operations](https://skmtc.dev/soleilpictures/apis/soleil-clusters-api/llms.txt) · [OpenAPI document](https://skmtc.dev/soleilpictures/apis/soleil-clusters-api/revisions/1d426d587bf3?raw)