Browse the help center

White Label API endpoints

Endpoint reference for the White Label tag (6 endpoints): Administrators only: network branding — the interface theme and the images the platform is served with. Needs the White Label console permission

Reference network manager admin

Administrators only: network branding — the interface theme and the images the platform is served with. Needs the White Label console permission. 6 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see REST API overview. Parameters marked form go in an application/x-www-form-urlencoded request body.

GET /rest-api/white-label/brand-images.do

Request examples

The limits a brand pack is read under.

No parameters beyond authentication.

Responses: 200 — {maxArchiveMb, maxPageMb, maxImageMb, maxTotalMb, maxImages, pdf} — maxPageMb is how much of a page’s markup is scanned. Errors follow the shared conventions.

POST /rest-api/white-label/brand-images.do

Request examples

Read the candidate images out of a brand pack.

ParameterInTypeRequiredDescription
urlformstringnoA public http(s) link to the brand’s page, or to one image or ZIP

Request body (multipart/form-data): form with field file — A ZIP of the brand’s image files, or one image file; up to 20 MB.

Responses: 200 — {images: [{name, contentType, origin, bytes}], total, more, source: {kind, origin}}. Errors follow the shared conventions.

GET /rest-api/white-label/brand-palette.do

Request examples

Whether a brand’s colours can be read for the theme.

No parameters beyond authentication.

Responses: 200 — {available, reason, maxPdfMb, maxImageMb, maxPageMb, maxTextLength}. Errors follow the shared conventions.

POST /rest-api/white-label/brand-palette.do

Request examples

Read a brand’s colours for the theme editor.

ParameterInTypeRequiredDescription
urlformstringnoA public http(s) link to the brand’s page or its guideline PDF
textformstringnoThe brand’s name, or the text of its guideline; up to 150,000 characters are read

Request body (multipart/form-data): form with field file — The brand’s guideline as a file: a PDF (up to 20 MB), a PNG, JPEG, GIF or WEBP image (up to 5 MB), or a text or HTML file (up to 2 MB).

Responses: 200 — {brands: [{brand, source, notes, readBy, colors: [{hex, role, name}]}], total, more, document: {kind, origin}} · 429 — This month’s AI budget is spent · 503 — No Anthropic key is set up, or the model could not be reached or answered something that cannot be read; try again. Errors follow the shared conventions.

GET /rest-api/white-label/login-background.do

Request examples

Whether a sign-in background can be drawn.

No parameters beyond authentication.

Responses: 200 — {available, reason, styles, maxNoteLength, maxColors}. Errors follow the shared conventions.

POST /rest-api/white-label/login-background.do

Request examples

Draw a sign-in background from a network’s colours.

ParameterInTypeRequiredDescription
styleformstringnoThe starting point: GRADIENT (colours blended across the frame), SHAPES (large soft overlapping shapes), GEOMETRY (a low-contrast repeating pattern) or GRAIN (a fine texture over a plain ground)
colorsformarray<string>noThe network’s colours as #rrggbb, the accent first; at most 8 are used and anything that is not a colour is left out
noteformstringnoOne line of the operator’s own on what it should feel like

Responses: 200 — {svg, style} · 429 — This month’s AI budget is spent · 503 — No Anthropic key is set up, or the model could not be reached, declined, or answered something that is not a drawing; try again. Errors follow the shared conventions.

Related pages

Please disable Adblock
Are you using adblock? Disable it and reload the page to proceed to the destination page.

A registration has already been submitted from this page. Please try again in 10 minutes.