Optimizely

Optimizely Product Images API

The Product Images API from Optimizely — 7 operation(s) for product images.

GitHub OpenAPI

Operations 11

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/ProductImages List product images · Returns the EntitySet ProductImages #
Ask an LLM
“Which images are attached to products in my commerce catalog?”
“Can I filter product images down to one product?”
Tell an agent
List all product images.
List product images matching {filter}.
POST /api/v1/admin/ProductImages Add an image to a product · Post a new entity to EntitySet ProductImages #
Ask an LLM
“How do I attach a new image to a product with small, medium and large paths?”
“Can I set alt text when adding a product image?”
Tell an agent
Add image {name} to product {productId} with large image path {largeImagePath}.
Attach an image to product {productId} with alt text {altText}.
GET /api/v1/admin/ProductImages({id}) Get a product image · Returns the entity with the key from ProductImages #
Ask an LLM
“What image paths and alt text does one product image record hold?”
“Can I fetch a single product image by its ID?”
Tell an agent
Get product image {id}.
Show the image paths of product image {id}.
PUT /api/v1/admin/ProductImages({id}) Replace a product image · Replace entity in EntitySet ProductImages #
Ask an LLM
“How do I overwrite a product image record entirely?”
“Does replacing a product image clear fields I don't include?”
Tell an agent
Replace product image {id} with a full record named {name}.
Overwrite product image {id} with medium image path {mediumImagePath}.
DELETE /api/v1/admin/ProductImages({id}) Delete a product image · Delete entity in EntitySet ProductImages #
Ask an LLM
“Can I remove one image from a product by its image ID?”
“Is it possible to delete a product image only if the ETag matches?”
Tell an agent destructive · confirm first
Delete product image {id}.
Delete product image {id} if its ETag is {etag}.
PATCH /api/v1/admin/ProductImages({id}) Update a product image · Update entity in EntitySet ProductImages #
Ask an LLM
“How do I change just the alt text on an existing product image?”
“Can I move one product image to a different sort position?”
Tell an agent
Change the alt text of product image {id} to {altText}.
Set the sort order of product image {id} to {sortOrder}.
GET /api/v1/admin/ProductImages/Default.Default() Get a blank product image template · Call operation Default #
Ask an LLM
“What default values does a new product image start with?”
“Can I fetch an empty product image template?”
Tell an agent
Fetch the default product image template.
Show the starting values for a new product image.
POST /api/v1/admin/ProductImages/Default.setsortorders Reorder several product images · Call operation setsortorders #
Ask an LLM
“How do I reorder a product's images in one call?”
“Can I set sort orders for a list of images at once?”
Tell an agent
Set the sort orders for these product images: {images}.
Reorder product images with the setsortorders action using {images}.
POST /api/v1/admin/productimages/setsortorders Call the route-style image sort order endpoint · Product images set sort orders 2 #
Ask an LLM
“Is there a lowercase productimages/setsortorders route with no declared body?”
“What does the route-style set sort orders endpoint for product images do?”
Tell an agent
Call the productimages/setsortorders route.
Invoke the route-style sort order endpoint for product images.
DELETE /api/v1/admin/productimages/delete Bulk delete product images · Product images delete route #
Ask an LLM
“Can I delete several product images at once?”
“How do I remove a batch of product images by ID?”
Tell an agent destructive · confirm first
Bulk delete product images {ids}.
Remove these product images in one call: {ids}.
GET /api/v1/admin/productimages({key})/customproperties({custompropertyKey}) Get a custom property on a product image · Product images get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom property stored on a product image?”
“What extra custom values does a product image carry?”
Tell an agent
Get custom property {custompropertyKey} on product image {key}.
Show product image {key}'s custom property {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-product-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-product-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

optimizely-product-images-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Product Images API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Product Images
paths:
  /api/v1/admin/ProductImages:
    get:
      tags:
      - Product Images
      summary: Returns the EntitySet ProductImages
      operationId: ProductImages_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:
      - Product Images
      summary: Post a new entity to EntitySet ProductImages
      operationId: ProductImages_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.ProductImage'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ProductImages({id}):
    get:
      tags:
      - Product Images
      summary: Returns the entity with the key from ProductImages
      operationId: ProductImages_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:
      - Product Images
      summary: Replace entity in EntitySet ProductImages
      operationId: ProductImages_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.ProductImage'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Product Images
      summary: Delete entity in EntitySet ProductImages
      operationId: ProductImages_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:
      - Product Images
      summary: Update entity in EntitySet ProductImages
      operationId: ProductImages_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.ProductImage'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ProductImages/Default.Default():
    get:
      tags:
      - Product Images
      summary: Call operation Default
      operationId: ProductImages_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ProductImages/Default.setsortorders:
    post:
      tags:
      - Product Images
      summary: Call operation setsortorders
      operationId: ProductImages_SetSortOrders_1
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                images:
                  type: array
                  items:
                    $ref: '#/components/schemas/Insite.Data.Entities.ProductImage'
        description: setsortorders action parameters
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/productimages/setsortorders:
    post:
      tags:
      - Product Images
      operationId: ProductImages_SetSortOrders_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Product images set sort orders 2
      x-summary-source: derived
  /api/v1/admin/productimages/delete:
    delete:
      tags:
      - Product Images
      operationId: ProductImages_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: Product images delete route
      x-summary-source: derived
  /api/v1/admin/productimages({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Product Images
      operationId: ProductImages_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: Product images get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.ProductImage:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        productId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        sortOrder:
          format: int32
          type: integer
        name:
          maxLength: 255
          minLength: 0
          type: string
        imageType:
          maxLength: 25
          minLength: 0
          type: string
        smallImagePath:
          maxLength: 1024
          minLength: 0
          type: string
        mediumImagePath:
          maxLength: 1024
          minLength: 0
          type: string
        largeImagePath:
          maxLength: 1024
          minLength: 0
          type: string
        altText:
          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