openapi: 3.2.0 info: title: Magnifi Partner Integration Highlights API version: v1 summary: Partner API for Magnifi by VideoVerse — stream ingestion, AI clip and highlight retrieval, roster and match-schedule management, and webhook subscriptions. description: Magnifi offers a comprehensive suite of API endpoints designed for seamless integration, enabling partners to access platform resources, content, and metadata efficiently. contact: name: Magnifi by VideoVerse url: https://magnifi.ai/contact-us termsOfService: https://magnifi.ai/terms-conditions servers: - url: '{PARTNER_BASE_URL}' description: Templated. Magnifi publishes its partner API base only as the Postman variable {{PARTNER_BASE_URL}}; the concrete host is issued to each partner alongside the Access Key and Access Secret and is not stated in the public documentation. variables: PARTNER_BASE_URL: default: '{PARTNER_BASE_URL}' description: Partner-specific API base URL issued by Magnifi. security: - AccessKey: [] AccessSecret: [] tags: - name: Highlights paths: /v1/highlight/{highlightId}: get: operationId: getHighlightByHighlightId summary: Get Highlight by highlightId tags: - Highlights description: 'Retrieves the metadata of a specific highlight. Params: HIGHLIGHT_ID (URL param): Specifies the unique identifier of the highlight.' parameters: - name: highlightId in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: object properties: statusCode: type: integer message: type: string data: type: object properties: version: type: integer metadata: type: object properties: highlight: type: object properties: highlightId: type: string highlightTitle: type: string streamId: type: string duration: type: number category: type: string aspectRatio: type: string clips: type: array items: type: object properties: clipId: type: string clipTitle: type: string streamId: type: string startTime: type: integer endTime: type: integer duration: type: integer category: type: string aspectRatio: type: string stream_start_time_buffer_secs: type: 'null' process_start_time: type: 'null' matchDetails: type: object properties: teams: {} players: {} tournament: {} events: {} outcome: {} partnerData: type: object properties: internal-v1: {} examples: getHL: value: statusCode: 200 message: Highlight data retrieved successfully data: version: 2 metadata: highlight: highlightId: 6474378824dfa0798770ccba highlightTitle: Untitled 1 streamId: W5Snsmv2P duration: 18.52 category: cricket aspectRatio: '16:9' clips: - clipId: 647491f0681ca15d9cfeaaca clipTitle: Clip 4 streamId: W5Snsmv2P startTime: 886 endTime: 895 duration: 9 category: cricket aspectRatio: '16:9' stream_start_time_buffer_secs: null process_start_time: null matchDetails: teams: - id: BFSorMfzt name: Scotland U19 - id: NivmunBS1 name: The Vision Shipping players: [] tournament: id: BJ7NujHO8 name: Sharjah CBFS T20 events: - six outcome: six partnerData: internal-v1: run: '' over: '' wicket: '' batterScores: '' bowlerStats: '' - clipId: 647491f1681ca15d9cfeaad4 clipTitle: Clip 4 streamId: W5Snsmv2P startTime: 886 endTime: 896 duration: 10 category: cricket aspectRatio: '16:9' stream_start_time_buffer_secs: null process_start_time: null matchDetails: teams: - id: BFSorMfzt name: Scotland U19 - id: NivmunBS1 name: The Vision Shipping players: - id: ae1d87f7-f126-43e3-b485-6a3ed9e1fcc3 name: Oliver Davidson kind: batsman - id: 315810aa-332e-4c87-8987-870e08320c52 name: Lyle Robertson kind: bowler tournament: id: BJ7NujHO8 name: Sharjah CBFS T20 events: - six outcome: six partnerData: internal-v1: run: '79' over: '12.1' wicket: '2' batterScores: '' bowlerStats: '' '500': description: Internal Server Error content: application/json: schema: type: object properties: statusCode: type: integer error: type: object properties: message: type: string code: type: string metadata: type: object examples: getHLHLNotFound: value: statusCode: 404 error: message: Highlight data not found code: H001 metadata: {} '404': description: Not Found content: application/json: schema: type: object properties: statusCode: type: integer error: type: object properties: message: type: string code: type: string metadata: type: object examples: getHLPermissionDenied: value: statusCode: 404 error: message: 'Permission denied: Entity mismatch' code: P001 metadata: {} '401': description: Unauthorized — invalid or missing x-access-key / x-access-secret. content: application/json: schema: $ref: '#/components/schemas/AuthError' default: description: Error response carrying a Magnifi error code. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: AuthError: type: object description: Returned when the access key or secret is missing or invalid. properties: message: type: string error: type: string statusCode: type: integer example: message: Invalid access key or access secret error: Unauthorized statusCode: 401 Error: type: object description: Magnifi error envelope. `error.code` is a Magnifi error code (see errors/videoverse-problem-types.yml). properties: statusCode: type: integer error: type: object properties: message: type: string code: type: string metadata: type: object example: statusCode: 404 error: message: Clip data not found code: C001 metadata: {} securitySchemes: AccessKey: type: apiKey in: header name: x-access-key description: 'Partner Access Key issued by Magnifi. Documented example prefix: pak_.' AccessSecret: type: apiKey in: header name: x-access-secret description: Partner Access Secret issued by Magnifi. Sent on every request alongside x-access-key. externalDocs: description: Magnifi x Partner Integration Documentation url: https://docs.prod.videoverse.dev/ x-generated-from: postman-collection x-source: https://documenter.gw.postman.com/api/collections/34141959/2sA3s6EpXt?segregateAuth=true&versionTag=latest x-generated-by: API Evangelist enrichment pipeline (local-v3) x-generated-on: '2026-09-04'