Skip to content

Read media outputs

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

Needs the read scope.

Call

  • Tool: get_media_outputs
  • Scope: read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
attachment string Yes
kinds array of "summary" or "chapters" or "transcript" No The outputs to read, each once; every one when none are named.
preview string No 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.
{
  "type": "object",
  "properties": {
    "attachment": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512
    },
    "kinds": {
      "description": "The outputs to read, each once; every one when none are named.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "summary",
          "chapters",
          "transcript"
        ]
      },
      "minItems": 1,
      "maxItems": 3
    },
    "preview": {
      "description": "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.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": [
    "attachment"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
unreadable array of string Yes The published outputs asked for that could not be read: some a later read may find, some only the merchant’s rewrite.
chapters array of object or null Yes
summary object or null Yes
transcript string or null Yes Plain text, its paragraphs apart by a blank line.

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close