# Start a direct upload for a workspace or profile image

Reserves the organization's storage and returns a signed URL to PUT the file to; the file is public once completed.

`POST /api/v1/public/uploads`

- Sign-in: A signed-in user's session: send the session id in the x-session-id header.
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 60 requests a minute per signedInWriteKey (some requests are not counted).

Reserves the organization's storage and returns a signed URL to PUT the file to; the file is public once completed. Answers 400 for a purpose other than `workspace-image` or `profile-image`, 403 when the organization has end-user uploads off or the file would take the user past their storage limit, 429 when too many uploads were started, and 503 when the organization's plan refuses it.

## Request

Send the body as `application/json`. The body is optional.

| Field         | Type   | Required | Constraints             | Description |
| ------------- | ------ | -------- | ----------------------- | ----------- |
| `name`        | string | No       | at most 1024 characters | -           |
| `size`        | number | No       | -                       | -           |
| `contentType` | string | No       | at most 255 characters  | -           |
| `purpose`     | string | No       | at most 64 characters   | -           |

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X POST "https://api.console.buildbase.app/api/v1/public/uploads" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example",
  "size": 1,
  "contentType": "string"
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/uploads',
  {
    method: 'POST',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Example',
      size: 1,
      contentType: 'string',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import os

import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/public/uploads",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "name": "Example",
        "size": 1,
        "contentType": "string",
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "expiresAt": "2026-01-01T00:00:00.000Z",
  "headers": {
    "Content-Type": "image/png",
    "x-goog-content-length-range": "0,12000",
    "x-goog-if-generation-match": "0",
    "x-goog-meta-org-id": "000000000000000000000001",
    "x-goog-meta-upload-id": "000000000000000000000002"
  },
  "maxBytes": 12000,
  "method": "PUT",
  "mode": "direct",
  "uploadId": "000000000000000000000002",
  "url": "http://localhost:4443/buildbase-local-staging/000000000000000000000001/000000000000000000000002?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=[REDACTED]&X-Goog-Date=20261111T070815Z&X-Goog-Expires=900&X-Goog-SignedHeaders=content-type%3Bhost%3Bx-goog-content-length-range%3Bx-goog-if-generation-match%3Bx-goog-meta-org-id%3Bx-goog-meta-upload-id&X-Goog-Signature=[REDACTED]"
}
```

### Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 400 Bad Request

**What it means:** The request failed a `validate()` schema, or an id in the path is not a valid id. `path` names the field.

**What to do:** Fix the field the body names in `path` (or read `message`) and send the request again. Nothing was changed.

```json title="Example"
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}
```

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [Uploads guide](/assets/overview): how this part of BuildBase works
- [All Uploads operations](/http-api/reference/uploads)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `uploads.create` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
