alpha

Reserve upload brand kit assets

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.

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)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

kitKeystring 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
labelstring required
restrictionstring
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
byteLengthinteger required

Exact size in bytes, at most 20 MiB.

sha256string required

Lowercase hex SHA-256 of the exact bytes you will upload.

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.