Optimizely Brand Category Images API

The Brand Category Images API from Optimizely — 6 operation(s) for brand category images.

Documentation GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/BrandCategoryImages List brand category images · Returns the EntitySet BrandCategoryImages #

Ask an LLM

“Which images are set up for our brand category pages?”

“Can I filter brand category images by brand or website?”

Tell an agent

List all brand category images.

List brand category images matching {filter}.

POST /api/v1/admin/BrandCategoryImages Add an image for a brand category · Post a new entity to EntitySet BrandCategoryImages #

Ask an LLM

“How do I set a manual image for a brand's category page?”

“Can a brand category image come from a product dynamically instead of a fixed file?”

Tell an agent

Add image {manualImagePath} with alt text {manualImageAltText} for brand {brandId} in category {categoryId}, source {imageSource}.

Create a new brand category image record on website {websiteId}.

GET /api/v1/admin/BrandCategoryImages({id}) Get a brand category image by id · Returns the entity with the key from BrandCategoryImages #

Ask an LLM

“What image path and alt text are stored on a particular brand category image?”

“Can I fetch one brand category image record by its id?”

Tell an agent

Get brand category image {id}.

Show the alt text and paths for brand category image {id}.

PUT /api/v1/admin/BrandCategoryImages({id}) Replace a brand category image record · Replace entity in EntitySet BrandCategoryImages #

Ask an LLM

“Can I overwrite every setting of a brand category image in one request?”

“Will a full replace of a brand category image clear fields I omit?”

Tell an agent

Replace brand category image {id} with source {imageSource}, manual path {manualImagePath} and alt text {manualImageAltText}.

Overwrite the full brand category image record {id}.

DELETE /api/v1/admin/BrandCategoryImages({id}) Delete a brand category image · Delete entity in EntitySet BrandCategoryImages #

Ask an LLM

“How do I remove one image from a brand category page?”

“Can I guard a brand category image delete with an ETag?”

Tell an agent destructive · confirm first

Delete brand category image {id}.

Delete brand category image {id} if it still matches ETag {etag}.

PATCH /api/v1/admin/BrandCategoryImages({id}) Update fields on a brand category image · Update entity in EntitySet BrandCategoryImages #

Ask an LLM

“Can I just change the alt text on a brand category image?”

“Is it possible to switch a brand category image to use a different product's picture?”

Tell an agent

Change the manual alt text of brand category image {id} to {manualImageAltText}.

Patch brand category image {id} to use the picture of product {manualImageProductId}.

GET /api/v1/admin/BrandCategoryImages/Default.Default() Call the brand category images Default function · Call operation Default #

Ask an LLM

“What does the Default function on brand category images return?”

“Is there a default brand category image entry I can fetch?”

Tell an agent

Call the Default function on brand category images.

Fetch the default brand category image result.

GET /api/v1/admin/brandcategoryimages/manualproductimages(brandId={brandId},parentCategoryId={parentCategoryId}) Get product images to choose for a brand category · Brand category images get manual product images by brandid and parentcategoryid #

Ask an LLM

“Which product images can I pick from when setting a manual image for a brand's category?”

“Can I see the candidate product pictures for a brand under a parent category?”

Tell an agent

List the manual product images for brand {brandId} under parent category {parentCategoryId}.

Show product picture options for brand {brandId} in category {parentCategoryId}.

DELETE /api/v1/admin/brandcategoryimages/delete Bulk delete brand category images by id · Brand category images delete route #

Ask an LLM

“Can I clear out several brand category images at once?”

“Is there a bulk delete that takes a list of brand category image ids?”

Tell an agent destructive · confirm first

Delete brand category images {ids}.

Bulk remove the brand category images with ids {ids}.

GET /api/v1/admin/brandcategoryimages({key})/customproperties({custompropertyKey}) Get a custom property of a brand category image · Brand category images get custom property by key and custompropertykey #

Ask an LLM

“Where can I read a custom property saved on a brand category image?”

“Can I fetch a single custom property value for one brand category image?”

Tell an agent

Get custom property {custompropertyKey} of brand category image {key}.

Show the custom value {custompropertyKey} stored on brand category image {key}.

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-brand-category-images-api-openapi.yml

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/optimizely:optimizely-brand-category-images-api"

All apis

curl "https://apis.io/api/v1/apis?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.

OpenAPI Specification

openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Brand Category Images API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Brand Category Images
paths:
  /api/v1/admin/BrandCategoryImages:
    get:
      tags:
      - Brand Category Images
      summary: Returns the EntitySet BrandCategoryImages
      operationId: BrandCategoryImages_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Brand Category Images
      summary: Post a new entity to EntitySet BrandCategoryImages
      operationId: BrandCategoryImages_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.BrandCategoryImage'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/BrandCategoryImages({id}):
    get:
      tags:
      - Brand Category Images
      summary: Returns the entity with the key from BrandCategoryImages
      operationId: BrandCategoryImages_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Brand Category Images
      summary: Replace entity in EntitySet BrandCategoryImages
      operationId: BrandCategoryImages_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.BrandCategoryImage'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Brand Category Images
      summary: Delete entity in EntitySet BrandCategoryImages
      operationId: BrandCategoryImages_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Brand Category Images
      summary: Update entity in EntitySet BrandCategoryImages
      operationId: BrandCategoryImages_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.BrandCategoryImage'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/BrandCategoryImages/Default.Default():
    get:
      tags:
      - Brand Category Images
      summary: Call operation Default
      operationId: BrandCategoryImages_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/brandcategoryimages/manualproductimages(brandId={brandId},parentCategoryId={parentCategoryId}):
    get:
      tags:
      - Brand Category Images
      operationId: BrandCategoryImages_GetManualProductImagesByBrandidAndParentcategoryid
      parameters:
      - name: brandId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: parentCategoryId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Brand category images get manual product images by brandid and parentcategoryid
      x-summary-source: derived
  /api/v1/admin/brandcategoryimages/delete:
    delete:
      tags:
      - Brand Category Images
      operationId: BrandCategoryImages_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Brand category images delete route
      x-summary-source: derived
  /api/v1/admin/brandcategoryimages({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Brand Category Images
      operationId: BrandCategoryImages_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Brand category images get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.BrandCategoryImage:
      required:
      - imageSource
      - dynamicImagePath
      - dynamicImageAltText
      - manualImagePath
      - manualImageAltText
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        brandId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        categoryId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        websiteId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        imageSource:
          maxLength: 1024
          minLength: 0
          type: string
        manualImageProductId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dynamicImagePath:
          maxLength: 1024
          minLength: 0
          type: string
        dynamicImageAltText:
          maxLength: 2048
          minLength: 0
          type: string
        manualImagePath:
          maxLength: 1024
          minLength: 0
          type: string
        manualImageAltText:
          maxLength: 2048
          minLength: 0
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query