postreef
All schemas

Gaming Clip

vidextract.predefined.gaming_clip.v1

A gaming or esports clip extracted from a video. Captures the game, the players or teams, and the standout moments of play. Only record names, scores, and games actually shown or stated — omit otherwise.

Fields

gamerequired
string

The game being played, e.g. 'League of Legends', 'Valorant', 'Minecraft'.

event
string

Tournament, league, or stream context if shown — e.g. 'LCS Summer Split'. Omit otherwise.

teams
string[]

Competing teams or orgs if it's a match, as shown — e.g. 'OpTic', 'Team Liquid'.

players
string[]

Player or streamer handles featured, if identifiable.

mode
string

Game mode or format if relevant — e.g. 'ranked', 'best-of-5', 'speedrun'. Omit otherwise.

highlightsrequired
object[]

Standout moments in order — plays, kills, objectives, clutch moments.

outcome
string

Result of the play or match if shown, e.g. 'OpTic takes the round'. Omit otherwise.

summary
string

One or two sentences describing the clip.

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "vidextract.predefined.gaming_clip.v1",
  "title": "Gaming Clip",
  "description": "A gaming or esports clip extracted from a video. Captures the game, the players or teams, and the standout moments of play. Only record names, scores, and games actually shown or stated — omit otherwise.",
  "type": "object",
  "required": [
    "game",
    "highlights"
  ],
  "additionalProperties": false,
  "properties": {
    "game": {
      "type": "string",
      "description": "The game being played, e.g. 'League of Legends', 'Valorant', 'Minecraft'."
    },
    "event": {
      "type": "string",
      "description": "Tournament, league, or stream context if shown — e.g. 'LCS Summer Split'. Omit otherwise."
    },
    "teams": {
      "type": "array",
      "description": "Competing teams or orgs if it's a match, as shown — e.g. 'OpTic', 'Team Liquid'.",
      "items": {
        "type": "string"
      }
    },
    "players": {
      "type": "array",
      "description": "Player or streamer handles featured, if identifiable.",
      "items": {
        "type": "string"
      }
    },
    "mode": {
      "type": "string",
      "description": "Game mode or format if relevant — e.g. 'ranked', 'best-of-5', 'speedrun'. Omit otherwise."
    },
    "highlights": {
      "type": "array",
      "description": "Standout moments in order — plays, kills, objectives, clutch moments.",
      "minItems": 1,
      "items": {
        "type": "object",
        "required": [
          "text"
        ],
        "additionalProperties": false,
        "properties": {
          "text": {
            "type": "string",
            "description": "What happens, e.g. 'Triple kill in the bot lane to swing the fight'."
          },
          "player": {
            "type": "string",
            "description": "Player or team responsible, if clear. Omit otherwise."
          },
          "videoTimestamp": {
            "type": "string",
            "description": "Start timestamp in the clip, 'mm:ss'. Omit if unknown.",
            "pattern": "^(\\d{1,2}:)?\\d{1,2}:\\d{2}$"
          }
        }
      }
    },
    "outcome": {
      "type": "string",
      "description": "Result of the play or match if shown, e.g. 'OpTic takes the round'. Omit otherwise."
    },
    "summary": {
      "type": "string",
      "description": "One or two sentences describing the clip."
    }
  }
}

Use it via the API

Pass schemaId: "vidextract.predefined.gaming_clip.v1" when you submit an extraction. The call returns an id immediately. Poll GET /v1/extractions/{id}/result (or register a webhook) for the structured result.

curl -s -X POST https://postreef.com/v1/extractions \
  -H "x-api-key: $VIDEXTRACT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
       "inputs": ["transcript", "comments"],
       "schemaId": "vidextract.predefined.gaming_clip.v1"}'

Full request/response shape in the API reference; copy-paste poll loops in the API quickstart.

Pass schemaId: "vidextract.predefined.gaming_clip.v1" in your request to extract with this schema.