---
title: "Reserve upload brand kit assets"
method: POST
path: "/api/v1/alpha/brand-kit-assets/reserve-upload"
tags: ["alpha"]
---

# Reserve upload brand kit assets

`POST /api/v1/alpha/brand-kit-assets/reserve-upload`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/alpha/brand-kit-assets/reserve-upload`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

Reserve an original asset for an active Brand Kit (a PNG, JPEG, WebP or SVG image, a WOFF, WOFF2, TTF or OTF font, or a DOCX, PPTX, XLSX or PDF document, at most 20 MiB), declaring its role, usage, label, media type, size and SHA-256. Returns the asset and one presigned upload: send the file as the body of exactly that request before it expires, then call alpha_brand_kit_assets_complete_upload. A kit revision names the asset by its artifactId.

## Headers

- `Point11-Organization` string, uuid
- `Idempotency-Key` string, uuid, required

## Request body

- AlphaBrandKitAssetsReserveUploadRequest
  - `kitKey` string, required: The active kit the asset is for.
  - `role` 'logo' | 'logo_dark' | 'icon' | 'image' | 'font_heading' | 'font_body' | 'screenshot' | 'template' | 'reference', required
  - `usage` 'reference_only' | 'web' | 'embed' | 'unavailable', required
  - `label` string, required
  - `restriction` string
  - `mediaType` 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/vnd.openxmlformats-officedocument.presentationml.presentation' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'application/pdf' | 'application/vnd.openxmlformats-officedocument.presentationml.template' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.template' | 'image/png' | 'image/jpeg' | 'image/webp' | 'image/svg+xml' | 'font/woff' | 'font/woff2' | 'font/ttf' | 'font/otf', required
  - `byteLength` integer, required: Exact size in bytes, at most 20 MiB.
  - `sha256` string, required: Lowercase hex SHA-256 of the exact bytes you will upload.

## Response `200`

Success.

- AlphaBrandKitAssetsReserveUploadResponse
  - `asset` AlphaBrandKitAssetsCompleteUploadResponse, required
    - `artifactId` string, uuid, required
    - `role` 'logo' | 'logo_dark' | 'icon' | 'image' | 'font_heading' | 'font_body' | 'screenshot' | 'template' | 'reference', required
    - `usage` 'reference_only' | 'web' | 'embed' | 'unavailable', required
    - `label` string, required
    - `restriction` string
    - `mediaType` 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/vnd.openxmlformats-officedocument.presentationml.presentation' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'application/pdf' | 'application/vnd.openxmlformats-officedocument.presentationml.template' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.template' | 'image/png' | 'image/jpeg' | 'image/webp' | 'image/svg+xml' | 'font/woff' | 'font/woff2' | 'font/ttf' | 'font/otf', required
    - `byteLength` integer, required
    - `status` 'pending' | 'ready', required: pending until alpha.brand-kit-assets.complete-upload.v1 proves the upload.
  - `upload` object, nullable, required: Send the file as the body of exactly this request before expiresAt; the response body is JSON naming the stored file's etag. Null when the file was already uploaded: call alpha.brand-kit-assets.complete-upload.v1.
    - `method` 'PUT', required
    - `url` string, uri, required
    - `headers` object, required
    - `expiresAt` string, date-time, required

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `402`: Billing refused the write: the code names the reason and `details.reason` carries it.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/36a84c7aca11?raw)