Skip to content
Navigation

Pages the store's files.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/assets

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Query parameters

  • filter
    optional
    object

    filter[<field>]=<value> is an equality, filter[<field>][<op>]=<value> names the operator; in repeats the parameter.

  • sort
    optional
    created
    or
    name
    or
    size
  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean
  • search
    optional
    string
    maxLength: 200 · minLength: 1
  • facets
    optional
    array of
    string

Returns

200

Pages the store's files.

JSON
  • items
    array of
    object
    required
    • uses
      object
      required
      • total
        number
        required
      • first
        required

        One of the following:

        • object
        • null
    • replace_failed
      boolean
      required
    • movable
      boolean
      required
    • id
      string
      required
    • locator
      required

      One of the following:

      • string
      • null
    • origin
      string
      required
    • custodian
      string
      required
    • enforcement
      string
      required
    • mime
      required

      One of the following:

      • string
      • null
    • bytes
      required

      The file's size in bytes; null when it is charged nothing.

      One of the following:

      • number
      • null
    • quota_bytes
      number
      required

      The file's size in bytes; zero when it is charged nothing.

    • name
      string
      required
    • title
      required

      One of the following:

      • string
      • null
    • ext
      required

      One of the following:

      • string
      • null
    • status
      string
      required
    • optimized
      boolean
      required
    • parent_id
      required

      One of the following:

      • string
      • null
    • redacted
      boolean
      required
    • security
      required

      One of the following:

      • string
      • null
    • description
      required

      One of the following:

      • string
      • null
    • processed_at
      required

      One of the following:

      • string
      • null
    • metadata
      object
      required
      • width
        optional
        integer
        minimum: 0
      • height
        optional
        integer
        minimum: 0
      • duration
        optional
        number

        Seconds, measured, so rarely whole.

      • pages
        optional
        integer
        minimum: 0
      • waveform
        optional

        An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.

        One of the following:

        • string
        • null
      • transcript
        optional
        object
        • language
          optional
          string
        • confidence
          optional
          number
      • arguments
        optional
        array of
        object

        What an MCP prompt asks for; only an authored prompt carries it.

        • name
          string
          required
        • description
          required

          One of the following:

          • string
          • null
        • required
          boolean
          required
        • default
          required

          One of the following:

          • string
          • null
        • match
          required

          Pattern the whole value must match, diacritic-insensitive.

          One of the following:

          • string
          • null
        • flags
          required

          Flags among i, s and u the pattern runs with; null for i alone.

          One of the following:

          • string
          • null
        • message
          required

          What a refused value is told instead of the default reason.

          One of the following:

          • string
          • null
        • lenient
          boolean
          required
    • created_at
      required

      One of the following:

      • string
      • null
  • cursor
    required

    One of the following:

    • string
    • null
  • total
    optional
    number
  • facets
    optional
    map of
    map<number>
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close