openapi: 3.2.0 info: title: Magnifi Partner Integration Player 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: Player paths: /v1/partner/player: post: operationId: addPlayer summary: Add player tags: - Player description: 'Allows you to create a new player in Partner''s organization. Request Body: category (string, required): The category of the player. playerName (string, required): The name of the player. metaData (object, required): Additional metadata for the player. jerseyNumber (number): The jersey number of the player. The metaData object is flexible, allowing you to pass any custom information needed when retrieving clip metadata.' requestBody: required: true content: application/json: schema: type: object properties: category: type: string playerName: type: string metaData: type: object properties: jerseyNumber: type: integer example: category: cricket playerName: Lasith Malinga metaData: jerseyNumber: 99 responses: '201': description: Created content: application/json: schema: type: object properties: statusCode: type: integer message: type: string data: type: object properties: id: type: string name: type: string category: type: string metadata: type: object properties: jerseyNumber: type: integer examples: addPlayer: value: statusCode: 201 message: Player added successfully data: id: 59accd29-067a-435a-abcd-caf6b6f83123 name: Lasith Malinga category: cricket metadata: jerseyNumber: 99 '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' get: operationId: getAllPlayers summary: Get all players tags: - Player description: 'Retrieves the list of players associated with the partner. Query Params: page (number, required): The page number to retrieve. pageSize (number, required): The number of items per page. category (string, optional): Filter players by specific category. search (string, optional): Search players by name. filters (object, optional): Additional filter on player metadata, e.g., { "extPlayerId" : "12345" }.' parameters: - name: page in: query required: false schema: type: integer example: '1' - name: pageSize in: query required: false schema: type: integer example: '2' responses: '201': description: Created content: application/json: schema: type: object properties: statusCode: type: integer message: type: string data: type: object properties: players: type: array items: type: object properties: id: type: string name: type: string category: type: string metadata: type: object properties: id: type: string jerseyNumber: type: integer nickName: type: string currentPage: type: integer pageSize: type: integer totalItems: type: integer totalPages: type: integer examples: getAllPlayers: value: statusCode: 200 message: Player data retrieved successfully data: players: - id: 7a3f2d4e-abcd-47a7-dsbs-417220594123 name: Joe Root category: cricket metadata: id: '12345' jerseyNumber: 63 nickName: Joe - id: 520af9ae-1234-4538-4321-bceee7ce49f8 name: Eon Morgan category: cricket metadata: id: '98764' jerseyNumber: 7 nickName: Morgan currentPage: 1 pageSize: 2 totalItems: 10 totalPages: 5 '200': description: Response content: application/json: schema: type: object properties: statusCode: type: integer message: type: string data: type: object properties: players: type: array items: type: object properties: id: type: string name: type: string category: type: string metadata: type: object properties: id: type: string jerseyNumber: type: integer nickName: type: string currentPage: type: integer pageSize: type: integer totalItems: type: integer totalPages: type: integer examples: getAllPlayersWithFilters: value: statusCode: 200 message: Player data retrieved successfully data: players: - id: 520af9ae-1234-4538-4321-bceee7ce49f8 name: Eon Morgan category: cricket metadata: id: '98764' jerseyNumber: 7 nickName: Morgan currentPage: 1 pageSize: 2 totalItems: 1 totalPages: 1 '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' /v1/partner/player/{playerId}: put: operationId: updatePlayerByPlayerId summary: Update player by playerId tags: - Player description: 'Allows you to update a player in Partner''s organization. Params: PLAYER_ID (URL param): Specifies the unique identifier of the player. Request Body: category (string, required): The category of the player. playerName (string, required): The name of the player. metaData (object, required): Additional metadata for the player. jerseyNumber (number): The jersey number of the player. The metaData object is flexible, allowing you to pass any custom information needed when retrieving clip metadata.' parameters: - name: playerId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: category: type: string playerName: type: string metaData: type: object properties: jerseyNumber: type: integer example: category: cricket playerName: Morgan metaData: jerseyNumber: 98 responses: '200': description: OK content: application/json: schema: type: object properties: statusCode: type: integer message: type: string data: type: object properties: id: type: string name: type: string category: type: string metadata: type: object properties: jerseyNumber: type: integer examples: updatePlayerByPlayerId: value: statusCode: 200 message: Player data updated successfully data: id: 59accd29-067a-435a-abcd-caf6b6f83123 name: Morgan category: cricket metadata: jerseyNumber: 98 '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' get: operationId: getPlayerByPlayerId summary: Get player by playerId tags: - Player description: 'Retrieves the details of a specific player associated with the partner. Params: PLAYER_ID (URL param): Specifies the unique identifier of the player.' parameters: - name: playerId 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: id: type: string name: type: string category: type: string metadata: type: object properties: jerseyNumber: type: integer examples: getPlayerByPlayerId: value: statusCode: 200 message: Player data retrieved successfully data: id: 59accd29-067a-435a-abcd-caf6b6f83123 name: Lasith Malinga category: cricket metadata: jerseyNumber: 99 '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'