openapi: 3.0.3
info:
  title: International Business Machines IBM Cloud Object Storage Analyze Recognition API
  description: The IBM Cloud Object Storage API provides a RESTful interface compatible with S3 for storing and retrieving objects in buckets. It supports features such as multipart uploads, versioning, lifecycle policies, and server-side encryption.
  version: 1.0.0
  contact:
    name: IBM Cloud
    url: https://cloud.ibm.com/docs/cloud-object-storage
  license:
    name: IBM Cloud Terms
    url: https://www.ibm.com/terms
servers:
- url: https://s3.us-south.cloud-object-storage.appdomain.cloud
  description: US South
- url: https://s3.eu-de.cloud-object-storage.appdomain.cloud
  description: EU Germany
- url: https://s3.eu-gb.cloud-object-storage.appdomain.cloud
  description: EU Great Britain
security:
- bearerAuth: []
tags:
- name: Recognition
  description: Recognize and transcribe audio.
paths:
  /v1/recognize:
    post:
      operationId: recognize
      summary: International Business Machines Recognize audio
      description: Send audio and receive a transcription of the audio content.
      tags:
      - Recognition
      parameters:
      - name: model
        in: query
        schema:
          type: string
        description: The model to use for recognition.
      - name: content-type
        in: header
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          audio/flac:
            schema:
              type: string
              format: binary
          audio/wav:
            schema:
              type: string
              format: binary
          audio/mp3:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: Successful transcription
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpeechRecognitionResults'
components:
  schemas:
    SpeechRecognitionResults:
      type: object
      properties:
        results:
          type: array
          items:
            type: object
            properties:
              final:
                type: boolean
              alternatives:
                type: array
                items:
                  type: object
                  properties:
                    transcript:
                      type: string
                    confidence:
                      type: number
        result_index:
          type: integer
        speaker_labels:
          type: array
          items:
            type: object
            properties:
              from:
                type: number
              to:
                type: number
              speaker:
                type: integer
              confidence:
                type: number
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: IAM Token