Skip to content
Navigation

Reserves a file and answers where to upload its bytes. A file of at most 2 MiB can go in the call instead, through the inline upload.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/uploads

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Request body JSON required

  • name
    string
    required
    maxLength: 200 · minLength: 1 · pattern: ^[a-z0-9][a-z0-9-]*$
  • mime
    string
    required
    maxLength: 128 · minLength: 1 · pattern: ^[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]*\/[a-zA-Z0-9][a-zA-Z0-9!#$&^_.+-]*$
  • bytes
    integer
    required

    The file's size in bytes, as the upload sends it.

    maximum: 5363466240 · minimum: 1
  • title
    optional

    One of the following:

    • string
    • null
  • ext
    optional

    The file's own extension; the mime's usual one when absent or null.

    One of the following:

    • string
    • null
  • enforcement
    optional
    public
    or
    signed

    How the file is served: public to anyone with its link, signed (the default) only through links that expire.

Returns

201

Reserves a file and answers where to upload its bytes. A file of at most 2 MiB can go in the call instead, through the inline upload.

JSON
  • asset
    object
    required
    • transforms
      array of
      object
      required
      • stage
        string
        required
      • params
        object
        required
        • level
          optional
          string
      • position
        number
        required
    • deliveries
      object
      required
      • items
        array of
        object
        required
        • id
          string
          required
        • asset_id
          string
          required
        • customer_id
          required

          One of the following:

          • string
          • null
        • member_id
          required

          One of the following:

          • string
          • null
        • intent
          string
          required
        • channel
          string
          required
        • issued_at
          required

          One of the following:

          • string
          • null
        • expires_at
          required

          One of the following:

          • string
          • null
        • revoked_at
          required

          One of the following:

          • string
          • null
        • max_uses
          required

          One of the following:

          • number
          • null
        • used_count
          number
          required
        • used_at
          required

          One of the following:

          • string
          • null
        • state
          string
          required
      • total
        number
        required
    • uses
      object
      required
      • items
        array of
        object
        required
        • attachment_id
          string
          required
        • asset_id
          string
          required
        • role
          string
          required
        • delivery
          string
          required
        • target
          object
          required
          • kind
            string
            required
          • id
            string
            required
        • from_body
          boolean
          required
        • detachable
          boolean
          required
        • release
          required

          The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.

          One of the following:

          • object
          • null
      • total
        number
        required
      • detachable
        number
        required
    • children
      object
      required
      • items
        array of
        string
        required
      • total
        number
        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
  • upload
    object
    required
    • url
      string
      required
    • method
      string
      required
    • headers
      map of
      string
      required
    • expires_at
      string
      required
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