Vendure

Vendure Assets API

The Assets API from Vendure — 2 operation(s) for assets.

Documentation GitHub OpenAPI

Operations 2

GET /assets/{assetPath} Retrieve Asset #

GET /assets/preview/{assetPath} Preview Asset Transform #

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/vendure-assets-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:
  title: Vendure Asset Server Assets API
  version: '3.6'
  description: 'REST surface exposed by `@vendure/asset-server-plugin`. The Asset Server

    plugin serves binary assets (images, files) uploaded via the Admin API

    and applies on-the-fly image transforms (preset, width, height, mode,

    format) for use by storefronts and the Vendure Dashboard.


    The plugin mounts at a configurable route (default `/assets`) and

    optionally a `/preview` route for transform previews. Storage can be

    local filesystem or an S3-compatible backend.'
  contact:
    name: Vendure
    url: https://docs.vendure.io/
  license:
    name: GPL-3.0
    url: https://github.com/vendurehq/vendure/blob/master/LICENSE
servers:
- url: http://localhost:3000
  description: Default development server
tags:
- name: Assets
paths:
  /assets/{assetPath}:
    get:
      summary: Retrieve Asset
      operationId: getAsset
      description: 'Serves the stored binary for the asset at `assetPath`. Supports

        image transforms via query parameters when the asset is an image.

        Responses include `Content-Type`, `Content-Length`, `ETag`, and

        cache headers; ranged requests are supported for large files.'
      parameters:
      - $ref: '#/components/parameters/AssetPath'
      - $ref: '#/components/parameters/PresetQuery'
      - $ref: '#/components/parameters/WidthQuery'
      - $ref: '#/components/parameters/HeightQuery'
      - $ref: '#/components/parameters/ModeQuery'
      - $ref: '#/components/parameters/FormatQuery'
      - $ref: '#/components/parameters/QualityQuery'
      responses:
        '200':
          description: Asset bytes.
          content:
            image/jpeg:
              schema:
                type: string
                format: binary
            image/png:
              schema:
                type: string
                format: binary
            image/webp:
              schema:
                type: string
                format: binary
            image/avif:
              schema:
                type: string
                format: binary
            application/octet-stream:
              schema:
                type: string
                format: binary
        '404':
          description: Asset not found.
      tags:
      - Assets
  /assets/preview/{assetPath}:
    get:
      summary: Preview Asset Transform
      operationId: previewAsset
      description: 'Returns a transformed preview of an image asset. Identical to the

        `/assets` route but explicitly routed to the preview pipeline; used

        by the Dashboard for thumbnail rendering.'
      parameters:
      - $ref: '#/components/parameters/AssetPath'
      - $ref: '#/components/parameters/PresetQuery'
      - $ref: '#/components/parameters/WidthQuery'
      - $ref: '#/components/parameters/HeightQuery'
      - $ref: '#/components/parameters/ModeQuery'
      - $ref: '#/components/parameters/FormatQuery'
      - $ref: '#/components/parameters/QualityQuery'
      responses:
        '200':
          description: Transformed image bytes.
          content:
            image/jpeg:
              schema:
                type: string
                format: binary
            image/png:
              schema:
                type: string
                format: binary
            image/webp:
              schema:
                type: string
                format: binary
        '404':
          description: Asset not found.
      tags:
      - Assets
components:
  parameters:
    QualityQuery:
      name: q
      in: query
      required: false
      description: Output quality (1-100) for lossy formats.
      schema:
        type: integer
        minimum: 1
        maximum: 100
    AssetPath:
      name: assetPath
      in: path
      required: true
      description: The stored asset path (filename and any storage prefix).
      schema:
        type: string
      example: source/91/demo-product.jpg
    WidthQuery:
      name: w
      in: query
      required: false
      description: Target width in pixels.
      schema:
        type: integer
        minimum: 1
        maximum: 8192
    ModeQuery:
      name: mode
      in: query
      required: false
      description: Fit mode for resizing.
      schema:
        type: string
        enum:
        - crop
        - resize
    HeightQuery:
      name: h
      in: query
      required: false
      description: Target height in pixels.
      schema:
        type: integer
        minimum: 1
        maximum: 8192
    FormatQuery:
      name: format
      in: query
      required: false
      description: Output format override.
      schema:
        type: string
        enum:
        - jpg
        - jpeg
        - png
        - webp
        - avif
    PresetQuery:
      name: preset
      in: query
      required: false
      description: Named preset configured on the AssetServerPlugin (`tiny`, `thumb`, `small`, `medium`, `large`, or custom).
      schema:
        type: string
        enum:
        - tiny
        - thumb
        - small
        - medium
        - large

Vendure Assets API

Operations 2

Documentation

Specifications

Schemas & Data

Other Resources