openapi: 3.1.1
info:
  title: MediaInput
  version: 2.0.0
  description: "Container schemas fetched from beckn.yaml. This cannot be extended as it is a reserved schema in beckn protocol. Any additional properties added to this schema can only be made using its *Attributes property"
  license:
    name: CC-BY-NC-SA 4.0 International
  contact:
    name: Beckn Labs
    url: https://beckn.io
components:
  schemas:
    MediaInput:
      x-iri: https://schema.nfh.global/MediaInput/v2.0
      description: Reference to an image, audio clip, or video used for multimodal search.
      title: MediaInput
      type: object
      properties:
        id:
          description: Client-supplied identifier for this media input.
          type: string
        type:
          description: Media category.
          type: string
          enum:
          - image
          - audio
          - video
        url:
          description: HTTPS URL or data URI pointing to the media resource.
          type: string
          format: uri
        contentType:
          description: MIME type, e.g., image/jpeg, audio/mpeg, video/mp4.
          type: string
        textHint:
          description: Optional pre-extracted text (OCR/ASR) for search augmentation.
          type: string
        language:
          description: Language code (BCP-47) of `textHint` or spoken audio.
          type: string
        startMs:
          description: Optional start offset in milliseconds (for audio/video segments).
          type: integer
        endMs:
          description: Optional end offset in milliseconds (for audio/video segments).
          type: integer
      required:
      - type
      - url
      additionalProperties: false
      x-tags:
      - common
