Skip to content
Navigation

Generates one of a video's or audio file's AI outputs, or generates it again, landing as a draft; subtitles first, the rest from them.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/assets/{asset}/outputs/generate

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • asset
    string
    required
    minLength: 1

Header parameters

  • Idempotency-Key
    optional
    string

    Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.

    maxLength: 255 · minLength: 1 · pattern: ^[\x21-\x7E]+$

Request body JSON required

  • kind
    summary
    or
    chapters
    or
    transcript
    or
    subtitles
    required

Returns

200

Generates one of a video's or audio file's AI outputs, or generates it again, landing as a draft; subtitles first, the rest from them.

JSON
  • kind
    string
    required
  • asset_id
    string
    required
  • status
    string
    required
  • has_content
    boolean
    required

    Whether content landed, which a run still generating or one that failed may keep from before.

  • revision
    number
    required

    The file's revision the content came from, or the running generation reads.

  • language
    required

    One of the following:

    • string
    • null
  • reason
    required

    One of the following:

    • string
    • null
  • bytes
    required

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

    One of the following:

    • number
    • null
  • deadline
    required

    One of the following:

    • string
    • null
  • updated_at
    required

    One of the following:

    • string
    • null
  • published_at
    required

    One of the following:

    • string
    • null
  • created_at
    required

    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