---
openapi: 3.0.3
info:
  title: Generated API
  version: "1.0"
servers:
- url: http://bhashini.ai
paths:
  /v1/synthesize:
    post:
      summary: Synthesize speech from text
      description: Use Bhashini Neural TTS engine to synthesize speech from Unicode
        text
      parameters:
      - name: X-API-KEY
        in: header
        description: Specify your API key (consisting of 32 characters) for going
          beyond rate limits and/or getting access to premium voices
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TextToSpeechInput'
      responses:
        default:
          description: Synthesized speech
          content:
            audio/mpeg: {}
        "400":
          description: Invalid languageId/voiceId/text in the request body
        "401":
          description: Trying to access premium voice but API key is missing or invalid
  /v1/translate:
    post:
      summary: "Translate text: English->Indic or Indic->English or Indic->Indic"
      description: Translate text from English to Indian language or Indian language
        to English or from one Indian language to another.
      parameters:
      - name: X-API-KEY
        in: header
        description: Specify your API key (consisting of 32 characters) for going
          beyond character limits
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TranslateInput'
      responses:
        default:
          description: Text translated into target language
          content:
            text/plain: {}
        "400":
          description: Invalid inputText/inputLanguage/outputLanguage in the request
            body
  /v1/transliterate:
    post:
      summary: Transliterate Indic text
      description: See Indic text in desired script
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransliterateInput'
      responses:
        default:
          description: Text transliterated into target script
          content:
            text/plain: {}
        "400":
          description: Invalid inputText/inputScriptId/outputScriptId in the request
            body
components:
  schemas:
    Language:
      enum:
      - Assamese
      - Bengali
      - Bodo
      - Dogri
      - English
      - Gujarati
      - Hindi
      - Kannada
      - Kashmiri
      - Konkani
      - Maithili
      - Malayalam
      - Manipuri
      - Marathi
      - Nepali
      - Odia
      - Punjabi
      - Sanskrit
      - Santali
      - Sindhi
      - Tamil
      - Telugu
      - Urdu
      type: string
    ScriptId:
      enum:
      - Beng
      - Deva
      - Gujr
      - Guru
      - Knda
      - Mlym
      - Orya
      - Taml
      - Telu
      type: string
    TextToSpeechInput:
      description: Input needed for synthesizing speech.
      required:
      - text
      - languageId
      - voiceId
      type: object
      properties:
        text:
          description: Unicode text for which speech needs to be synthesized.
          type: string
          example: "सौर मंडल में सूर्य और वह खगोलीय पिंड सम्मलित हैं, जो इस मंडल म\
            ें एक दूसरे से गुरुत्वाकर्षण बल द्वारा बंधे हैं।"
        languageId:
          description: 2-digit laguage code as in ISO 639-1
          type: string
          example: hi
        voiceId:
          format: int32
          description: "Voice ID: 0 for Female1, 1 for Male1 etc."
          type: integer
          example: 0
    TranslateInput:
      description: Input needed for Transliteration.
      required:
      - inputText
      - inputLanguage
      - outputLanguage
      type: object
      properties:
        inputText:
          description: Unicode text which needs to be transliterated.
          type: string
          example: Chandrayaan-3 is the third and most recent lunar Indian Space Research
            exploration mission under the Chandrayaan programme of ISRO. It consists
            of a lander named Vikram and a rover named Pragyan similar to Chandrayaan-2.
            Its propulsion module behaves like an Orbiter. The propulsion module carries
            the lander and rover configuration until the spacecraft is in a 100-kilometre
            (62 mi) lunar orbit.
        inputLanguage:
          allOf:
          - $ref: '#/components/schemas/Language'
          - description: Source language (Indic/English) of input-text
            example: English
        outputLanguage:
          allOf:
          - $ref: '#/components/schemas/Language'
          - description: Target language (Indic/English) in to which the inputText
              needs to be translated to
            example: Hindi
    TransliterateInput:
      description: Input needed for Transliteration.
      required:
      - inputText
      - inputScriptId
      - outputScriptId
      type: object
      properties:
        inputText:
          description: Unicode text which needs to be transliterated.
          type: string
          example: கடல்களுக்கான உரோமானியக்கடவுள் நெப்டியூன் என்பவரின் பெயரே ஞாயிற்றுத்
            தொகுதியில் உள்ள கோளான நெப்டியூன் கோளிற்கு சூட்டப்பட்டது.
        inputScriptId:
          allOf:
          - $ref: '#/components/schemas/ScriptId'
          - description: 4-digit script code (as per ISO 15924) of the input text
            example: Taml
        outputScriptId:
          allOf:
          - $ref: '#/components/schemas/ScriptId'
          - description: 4-digit script code (as per ISO 15924) in which the output
              text is expected
            example: Knda