Skip to content
Navigation

Reads a video's or audio file's published chapters, summary and transcript, where the customer may play it.

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

Authorization

  • bearer
    optional
    HTTP
  • publishableKey
    optional
    API key in header

Path parameters

  • store
    string
    required

    A hostname of the store.

Query parameters

  • attachment
    string
    required
    maxLength: 512 · minLength: 1
  • kinds
    optional
    array of
    string

    The outputs to read, each once; every one when none are named.

  • preview
    optional
    string

    A token a seller made for a product's or a page's page, which opens the files its read lists unpublished, gated as ever.

    maxLength: 128 · minLength: 1

Returns

200

Reads a video's or audio file's published chapters, summary and transcript, where the customer may play it.

JSON
  • unreadable
    array of
    string
    required

    The published outputs asked for that could not be read: some a later read may find, some only the merchant's rewrite.

  • chapters
    required

    One of the following:

    • array<object>
    • null
  • summary
    required

    One of the following:

    • object
    • null
  • transcript
    required

    Plain text, its paragraphs apart by a blank line.

    One of the following:

    • string
    • null
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