Generated by API Evangelist
Written by API Evangelist tooling for Canvas's API. It is a proposal applied on top of the contract, not a document Canvas publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Canvas LMS REST Brand Configs API
version: 1.0.0
extends: openapi/canvas-brand-configs-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/v1/brand_variables'].get
update:
x-apievangelist-phrasing:
intent: Get the theme variables for this domain
effect: read
questions:
- What brand colors and logos does this Canvas domain use?
- How can a mobile app read the institution's theme variables?
instructions:
- text: Get the brand variables for this Canvas domain.
- text: Fetch the institution's theme colors and logos.
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/brand_variables'].get
update:
x-apievangelist-phrasing:
intent: Get the theme variables for a sub-account
effect: read
questions:
- Which brand colors does a particular sub-account use?
- Can a sub-account have different theme variables from the root account?
instructions:
- text: Get the brand variables for sub-account {account_id}.
slots:
account_id: path.account_id
- text: Show the theme colors used by account {account_id}.
slots:
account_id: path.account_id
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/brand_variables'].get
update:
x-apievangelist-phrasing:
intent: Get the theme variables applied to a course
effect: read
questions:
- What branding is applied to a specific course?
- Which theme colors and logo does a course inherit?
instructions:
- text: Get the brand variables for course {course_id}.
slots:
course_id: path.course_id
- text: Show the theme colors applied in course {course_id}.
slots:
course_id: path.course_id
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.