Sports Game Synopsis Generator

Public

API Details

This API generates brief synopses (maximum 100 characters) for each game in an upcoming round of a specified sports league. The synopses are designed to provide quick, engaging previews similar to those found on sports streaming platforms like Kayo Sports. The API takes the league name, round number, and details of each game (including teams, venue, and date) as input and returns concise, attention-grabbing synopses that highlight key aspects or storylines for each matchup.

Request Schema

{
  "type": "object",
  "required": [
    "league",
    "round",
    "games"
  ],
  "properties": {
    "games": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "homeTeam",
          "awayTeam",
          "venue",
          "date"
        ],
        "properties": {
          "date": {
            "type": "string",
            "format": "date",
            "description": "The date of the game (YYYY-MM-DD)"
          },
          "venue": {
            "type": "string",
            "description": "The name of the venue where the game will be played"
          },
          "awayTeam": {
            "type": "string",
            "description": "The name of the away team"
          },
          "homeTeam": {
            "type": "string",
            "description": "The name of the home team"
          }
        }
      },
      "description": "An array of game objects containing details for each matchup"
    },
    "round": {
      "type": "integer",
      "description": "The round number of the upcoming games"
    },
    "league": {
      "type": "string",
      "description": "The name of the sports league (e.g., NRL, AFL, NBA)"
    }
  }
}

Response Schema

{
  "type": "object",
  "required": [
    "synopses"
  ],
  "properties": {
    "synopses": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "game",
          "synopsis"
        ],
        "properties": {
          "game": {
            "type": "string",
            "description": "A string identifying the game (typically 'Home Team vs Away Team')"
          },
          "synopsis": {
            "type": "string",
            "maxLength": 100,
            "description": "A brief, engaging synopsis of the game, maximum 100 characters"
          }
        }
      },
      "description": "An array of synopsis objects, one for each game in the input"
    }
  }
}

API Metadata

652

Version

API Examples

Example Request

{
  "games": [
    {
      "date": "2024-04-05",
      "venue": "Suncorp Stadium",
      "awayTeam": "Melbourne Storm",
      "homeTeam": "Brisbane Broncos"
    },
    {
      "date": "2024-04-06",
      "venue": "Allianz Stadium",
      "awayTeam": "Penrith Panthers",
      "homeTeam": "Sydney Roosters"
    }
  ],
  "round": 5,
  "league": "NRL"
}

Example Response

{
  "synopses": [
    {
      "game": "Brisbane Broncos vs Melbourne Storm",
      "synopsis": "Broncos aim to tame Storm in Friday night blockbuster at Suncorp. Can they break the Melbourne hoodoo?"
    },
    {
      "game": "Sydney Roosters vs Penrith Panthers",
      "synopsis": "Roosters face defending champs Panthers in crucial clash. Will home advantage be key for Sydney?"
    }
  ]
}