Skip to content
Navigation

Answers the bytes of a private file a capability names, to the bearer or the publishable key that asked for it.

A video or audio file a customer's token asked for is answered by its URL alone, with no credential, so a bare <video src> plays it; any other file needs its credential.

GET
https://api.sherpo.io/customer/v1/stores/{store}/files/{capability}

Authorization

  • bearer
    optional
    HTTP
  • publishableKey
    optional
    API key in header

Path parameters

  • store
    string
    required

    A hostname of the store.

  • capability
    string
    required

    The capability in the URL POST /attachments/url answered: the path segment after /files/. A file name may follow it as another segment, never inside this one.

    minLength: 1

Query parameters

  • publishable_key
    optional
    string

    The publishable key the URL was asked for with, already on the URL POST /attachments/url answered, so a bare src can name it: it stands in for the Publishable-Key header, and may be sent beside it only with the same key. A customer's token is never taken in the URL.

    maxLength: 512 · minLength: 1

Header parameters

  • Range
    optional
    string

    One byte range of a file shown in place, bytes={first}-{last}, bytes={first}- or bytes=-{suffix}; a download is answered whole.

  • If-Range
    optional
    string

    The file's ETag from an earlier answer: the range is answered only while the file is unchanged, else the whole file.

Returns

200

The file's bytes, with its type and disposition.

206

The range asked for.

416

The range lies outside the file, or is other than one bytes range.
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
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