POST /v1/branding/favicon
Stores a PNG favicon (16 to 512 pixels, square, at most 256 KiB, re-encoded without metadata) on the assets host and returns its URL for favicon_url. Pro plan and above; other plans answer plan_limit_reached. Anything else answers logo_invalid.
- Scope
branding:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Honoured for 24 h; a replay returns the original response.Idempotency-Keystringmin length 1 · max length 255
Request body
Section titled “Request body”
The file, standard base64 (padding required).datastring Requiredmin length 4 · max length 699052
Responses
Section titled “Responses”- 201 Created BrandingFavicon
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X POST \ "https://api.ohauthcat.com/v1/branding/favicon" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "data": "example_data"}'const response = await fetch("https://api.ohauthcat.com/v1/branding/favicon", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "data": "example_data" }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/branding/favicon", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "data": "example_data", },)data = response.json(){ "object": "branding_favicon", "favicon_url": "https://app.acme.com/callback", "size_bytes": 1}