Qlik Sense · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brands API

13 actions 13 updates phrasing extends openapi/qliksense-brands-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Qlik Sense's API. It is a proposal applied on top of the contract, not a document Qlik Sense publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info
$.paths['/api/v1/brands'].get
$.paths['/api/v1/brands'].post
$.paths['/api/v1/brands/{brand-id}'].get
$.paths['/api/v1/brands/{brand-id}'].delete
$.paths['/api/v1/brands/{brand-id}'].patch
$.paths['/api/v1/brands/{brand-id}/actions/activate'].post
$.paths['/api/v1/brands/{brand-id}/actions/deactivate'].post
$.paths['/api/v1/brands/{brand-id}/files/{brand-file-id}'].get
$.paths['/api/v1/brands/{brand-id}/files/{brand-file-id}'].put
$.paths['/api/v1/brands/{brand-id}/files/{brand-file-id}'].post
$.paths['/api/v1/brands/{brand-id}/files/{brand-file-id}'].delete
$.paths['/api/v1/brands/active'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Brands API
  version: 1.0.0
extends: openapi/qliksense-brands-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/api/v1/brands'].get
  update:
    x-apievangelist-phrasing:
      intent: List brands
      effect: read
      questions:
      - Which custom brands are defined on my Qlik tenant?
      - Can I page through all brand entries?
      instructions:
      - text: List all brands on my tenant.
      - text: Show up to {limit} brands sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/brands'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a brand
      effect: write
      questions:
      - How do I add a custom brand with my own logo?
      - Can I create a new brand with custom styles and a favicon?
      instructions:
      - text: Create a brand named {name}.
        slots:
          name: requestBody.name
      - text: Create a brand called {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/brands/{brand-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand
      effect: read
      questions:
      - Where can I see the details of a specific brand?
      - What logo and styles does a given brand use?
      instructions:
      - text: Get brand {brand-id}.
        slots:
          brand-id: path.brand-id
      - text: Show me the details of brand {brand-id}.
        slots:
          brand-id: path.brand-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/brands/{brand-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a brand
      effect: destructive
      questions:
      - What happens if I delete the brand that is currently active?
      - How do I remove a brand I no longer use?
      instructions:
      - text: Delete brand {brand-id}.
        slots:
          brand-id: path.brand-id
      - text: Remove the brand {brand-id} from the tenant.
        slots:
          brand-id: path.brand-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/brands/{brand-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a brand
      effect: write
      questions:
      - Can I change the name or description of an existing brand?
      - How do I edit a brand's settings?
      instructions:
      - text: Update brand {brand-id}.
        slots:
          brand-id: path.brand-id
      - text: Edit the properties of brand {brand-id}.
        slots:
          brand-id: path.brand-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/brands/{brand-id}/actions/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a brand
      effect: write
      questions:
      - How do I make a custom brand the one users see?
      - Does activating a brand turn off the currently active one?
      instructions:
      - text: Activate brand {brand-id}.
        slots:
          brand-id: path.brand-id
      - text: Make {brand-id} the tenant's active brand.
        slots:
          brand-id: path.brand-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/brands/{brand-id}/actions/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a brand
      effect: write
      questions:
      - How do I go back to the Qlik default brand?
      - Can I switch off a custom brand without deleting it?
      instructions:
      - text: Deactivate brand {brand-id}.
        slots:
          brand-id: path.brand-id
      - text: Turn off brand {brand-id} and revert to the default look.
        slots:
          brand-id: path.brand-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/brands/{brand-id}/files/{brand-file-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a brand file
      effect: read
      questions:
      - How do I download the logo or favicon file from a brand?
      - Can I fetch a brand's image file?
      instructions:
      - text: Download file {brand-file-id} from brand {brand-id}.
        slots:
          brand-file-id: path.brand-file-id
          brand-id: path.brand-id
      - text: Get the {brand-file-id} image of brand {brand-id}.
        slots:
          brand-file-id: path.brand-file-id
          brand-id: path.brand-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/brands/{brand-id}/files/{brand-file-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an existing brand file
      effect: write
      questions:
      - How do I swap out the logo already uploaded to a brand?
      - Can I replace an existing favicon file on a brand?
      instructions:
      - text: Replace file {brand-file-id} on brand {brand-id} with {file}.
        slots:
          brand-file-id: path.brand-file-id
          brand-id: path.brand-id
          file: requestBody.file
      - text: Update the existing {brand-file-id} file of brand {brand-id}.
        slots:
          brand-file-id: path.brand-file-id
          brand-id: path.brand-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/brands/{brand-id}/files/{brand-file-id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a new brand file
      effect: write
      questions:
      - How do I upload a logo to a brand for the first time?
      - Can I add a favicon file to a brand that has none?
      instructions:
      - text: Upload {file} as the new {brand-file-id} file for brand {brand-id}.
        slots:
          file: requestBody.file
          brand-file-id: path.brand-file-id
          brand-id: path.brand-id
      - text: Add a {brand-file-id} file to brand {brand-id}.
        slots:
          brand-file-id: path.brand-file-id
          brand-id: path.brand-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/brands/{brand-id}/files/{brand-file-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a brand file
      effect: destructive
      questions:
      - How do I remove the logo from a brand?
      - Can I delete just one file from a brand?
      instructions:
      - text: Delete file {brand-file-id} from brand {brand-id}.
        slots:
          brand-file-id: path.brand-file-id
          brand-id: path.brand-id
      - text: Remove the {brand-file-id} image from brand {brand-id}.
        slots:
          brand-file-id: path.brand-file-id
          brand-id: path.brand-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/brands/active'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the active brand
      effect: read
      questions:
      - Which brand is currently active on my tenant?
      - Is my tenant using the Qlik default brand or a custom one?
      instructions:
      - text: Show the currently active brand.
      - text: Tell me which brand users see right now.
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/qliksense-brands-api-phrasing-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.