openapi: 3.2.0
info:
  title: Magnifi Partner Integration Catch me up 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: Catch me up
paths:
  /v1/catch-me-up/highlight:
    get:
      operationId: getCatchMeUpHighlight
      summary: Get Catch me up Highlight
      tags:
      - Catch me up
      parameters:
      - name: configId
        in: query
        required: false
        schema:
          type: string
      - name: streamId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      catchMeUpHL:
                        type: object
                        properties:
                          id:
                            type: string
                          configId:
                            type: string
                          entityId:
                            type: string
                          clips:
                            type: array
                            items:
                              type: object
                              properties:
                                clipId:
                                  type: string
                                duration:
                                  type: number
                                preSignedUrl:
                                  type: string
              examples:
                getCatchMeUpHighlight:
                  value:
                    statusCode: 200
                    message: Catch me up HL retrieved successfully
                    data:
                      catchMeUpHL:
                        id: cmu_hl_a6c33f5a-8067-4135-9e31-a6c33f5a3afc
                        configId: cmu_cfg_60566546-4444-46f1-1234-7baamadu8ba0
                        entityId: entityId
                        clips:
                        - clipId: 6798a5271a42800009488f9f
                          duration: 7.834
                          preSignedUrl: <link to a mp4 file>
                        - clipId: 6798a4d9b52e4e000923b1db
                          duration: 6.134
                          preSignedUrl: <link to a mp4 file>
                        - clipId: 6798a465b52e4e000923af4d
                          duration: 5.6
                          preSignedUrl: <link to a mp4 file>
        '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
                        properties:
                          configId:
                            type: string
                          streamId:
                            type: string
                          entityId:
                            type: string
                          userId:
                            type: string
              examples:
                getCatchMeUpHighlightNotAvailable:
                  value:
                    statusCode: 404
                    error:
                      message: Catch me up Highlight is not yet ready for this stream
                      code: CM001
                      metadata:
                        configId: cmu_cfg_18a6e30b-6b96-4a86-bdcc-012345c8d4f4
                        streamId: eHqq4ZTuu
                        entityId: org_11111111-a5fb-4815-b0f5-2222adde5ef
                        userId: qdgvbzVAz
        '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'