International Business Machines

International Business Machines Synthesis API

Synthesize text to audio.

Documentation GitHub OpenAPI

Documentation

https://cloud.ibm.com/apidocs/watsonx-ai

https://cloud.ibm.com/apidocs/assistant-v2

https://cloud.ibm.com/apidocs/natural-language-understanding

https://cloud.ibm.com/apidocs/speech-to-text

https://cloud.ibm.com/apidocs/text-to-speech

https://cloud.ibm.com/docs/cloud-object-storage

https://cloud.ibm.com/apidocs/kubernetes/containers-v1-v2

https://cloud.ibm.com/apidocs/vpc/latest

Specifications

https://raw.githubusercontent.com/api-evangelist/international-business-machines/refs/heads/main/openapi/international-business-machines-synthesis-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/international-business-machines/refs/heads/main/json-schema/foundation-model.json

https://raw.githubusercontent.com/api-evangelist/international-business-machines/refs/heads/main/json-schema/text-generation-request.json

https://raw.githubusercontent.com/api-evangelist/international-business-machines/refs/heads/main/json-schema/assistant-message.json

https://raw.githubusercontent.com/api-evangelist/international-business-machines/refs/heads/main/json-schema/nlu-analysis.json

https://raw.githubusercontent.com/api-evangelist/international-business-machines/refs/heads/main/json-schema/speech-recognition-result.json

https://raw.githubusercontent.com/api-evangelist/international-business-machines/refs/heads/main/json-schema/bucket.json

https://raw.githubusercontent.com/api-evangelist/international-business-machines/refs/heads/main/json-schema/cluster.json

https://raw.githubusercontent.com/api-evangelist/international-business-machines/refs/heads/main/json-schema/vpc.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/international-business-machines/refs/heads/main/json-ld/international-business-machines-context.jsonld

OpenAPI Specification

openapi: 3.0.3
info:
  title: International Business Machines IBM Cloud Object Storage Analyze Synthesis 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: Synthesis
  description: Synthesize text to audio.
paths:
  /v1/synthesize:
    post:
      operationId: synthesize
      summary: International Business Machines Synthesize audio
      description: Synthesize text to audio. Returns the audio in the specified format.
      tags:
      - Synthesis
      parameters:
      - name: Accept
        in: header
        schema:
          type: string
          enum:
          - audio/wav
          - audio/mp3
          - audio/ogg
          - audio/flac
      - name: voice
        in: query
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - text
              properties:
                text:
                  type: string
      responses:
        '200':
          description: Successful synthesis
          content:
            audio/wav:
              schema:
                type: string
                format: binary
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: IAM Token