Get Project Highlight Options

Overview

Use this endpoint before creating highlight packages or recaps. It returns the event types, teams, players, fights, highlight IDs, and OTIO readiness available for a project. Only OTIO-ready highlights can be used in the public package EDL contract. Current highlights generate otio_edit automatically, so new highlights should report otio_ready: true. Every matched or selected highlight must have otio_ready: true for package or recap creation.

Request

curl -X GET "https://api.narrative-sports.com/v1/projects/1/highlight-options" \
  -H "Authorization: Bearer YOUR_API_KEY"

Path Parameters

Parameter	Type	Required	Description
`project_id`	integer	Yes	Project ID to inspect

Response

{
  "project_id": 1,
  "project_name": "Cup Final",
  "event_types": [
    { "value": "goal", "count": 4, "otio_ready_count": 4 }
  ],
  "teams": [
    { "value": "Argentina", "count": 6, "otio_ready_count": 6 }
  ],
  "players": [
    { "value": "Lionel Messi", "count": 3, "otio_ready_count": 3 }
  ],
  "fights": [],
  "highlights": [
    {
      "id": "edit-1",
      "event_type": "goal",
      "event_description": "Opening goal",
      "target_team": "Argentina",
      "target_players": ["Lionel Messi"],
      "otio_ready": true
    }
  ],
  "total_highlights": 1,
  "otio_ready_highlights": 1
}

Using Options in Package Creation

Use the option values directly when calling Create Highlight Package:

Field from this endpoint	Use in package request
`event_types[].value`	`event_type_filter`
`teams[].value`	`team_filter`
`players[].value`	`player_filter`
`fights[].fight_number`	`fight_filter` or `selected_fights` for MMA fight-specific packages
`fights[].highlight_ids`	`selected_edit_ids` for exact MMA highlight selection
`highlights[].id`	`selected_edit_ids` for exact highlight selection

count shows all matching highlights for an option. otio_ready_count is always an integer and shows how many of those highlights can be used in package and recap EDL creation. For exact highlight selection, use highlights[].otio_ready as the per-highlight source of truth.

Using Options in Recap Creation

For Create Recap, use a selected fight’s highlight_ids as selected_edit_ids. Combine and deduplicate the IDs when selecting several fights. Check that the list is nonempty before submission; an empty list does not restrict the recap. Recap creation does not support fight_filter or selected_fights; those fields apply to highlight packages. See Create a Single-Fight Recap.

Errors

Status	Description
`401`	Invalid or missing API key
`404`	Project not found or does not belong to the authenticated customer

Overview

Task Creation

Task Management

License Usage

Deprecated

Highlights

Highlight Packages (Early Beta)

Recaps

Get Project Highlight Options

Overview

Request

Path Parameters

Response

Using Options in Package Creation

Using Options in Recap Creation

Errors

​Overview

​Request

​Path Parameters

​Response

​Using Options in Package Creation

​Using Options in Recap Creation

​Errors

Overview

Request

Path Parameters

Response

Using Options in Package Creation

Using Options in Recap Creation

Errors