# uploads.create

Stage a binary attachment upload.

Streams the request body (the file's raw bytes, NOT base64, NOT multipart) into staging storage and returns a `blobId` to reference from `/send`, `/compose` or `/reply` (the `blobId` form of an attachment). `Content-Length` is required and enforced against the per-message size ceiling. The staged blob expires at the result's `expiresAt`, or earlier when the uploader's oldest temporary blobs must be reclaimed for a new upload. Recorded send retries recover their durable message bytes.

```ts
openemail.uploads.create(
  mailboxId: string,
  data: RawBody,
  options?: UploadsCreateOptions,
): ApiPromise<UploadResult>
```

It calls `POST /mailboxes/{mailboxId}/uploads`: [Stage a binary attachment upload](/docs/api/uploads/post_UploadCreate) in the API reference.

## Example

```ts
const uploadResult = await openemail.uploads.create(mailboxId, data)
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `mailboxId` | `string` | Mailbox ULID identifier. The path's `{mailboxId}`. |
| `data` | [`RawBody`](/docs/sdks/typescript/calling-methods#raw-bodies) | The file's raw bytes, streamed as sent. The request's body, as bytes: text, a `Blob`, an `ArrayBuffer` or a `Uint8Array` ([raw bodies](/docs/sdks/typescript/calling-methods#raw-bodies)). |

## Options

The last argument, `options`, a `UploadsCreateOptions`, takes:

| Option | Type | Sent as | Description |
| --- | --- | --- | --- |
| `contentType` | `string` | header `content-type` | MIME type of the uploaded file (default application/octet-stream) |

Every call also takes `signal`, `timeout`, `retry` and `headers`, which say how that one call is sent ([call options](/docs/sdks/typescript/calling-methods#call-options)).

## Answer

Awaited, it is the API's JSON, [`UploadResult`](/docs/sdks/typescript/types/upload-result). It is an [`ApiPromise`](/docs/sdks/typescript/responses): `.withResponse()` gives the same with the `Response` it came in, for its headers.

## Errors

| Status | What it means |
| --- | --- |
| `400` | empty_body — request body was empty |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `404` | Mailbox not found or not accessible to this principal |
| `411` | length_required — Content-Length header is required |
| `413` | too_large — file exceeds maximum message size; metadata_too_large — Content-Type exceeds metadata limit |
| `429` | upload_busy — concurrent upload allowance is full |
| `503` | upload_cleanup_pending — temporary storage reclamation must be retried. Or temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |
| `507` | store_full — owner storage is full and this uploader has no reclaimable space |

A failed call rejects with a [`RequestError`](/docs/sdks/typescript/errors): its `status`, and its `code`, the API's `error`. Decide on the code: one status covers several.

## Types

It names these types of the API, each on a page of its own: [`UploadResult`](/docs/sdks/typescript/types/upload-result).
