{
  "opencollection": "1.0.0",
  "info": {
    "name": "Speech AI Service Speech API",
    "version": "20220101"
  },
  "items": [
    {
      "info": {
        "name": "AIServiceSpeech",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Creates a session and sends a token so that users can authenticate themselves. An alternate way to authenticate is by skipping this endpoint and directly using the credentials in the SDK.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://$SWAGGER_HOST_URL/20220101/actions/realtimeSessionToken",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns an authentication token to the user.\n"
        },
        {
          "info": {
            "name": "Creates an audio for the given input text.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://$SWAGGER_HOST_URL/20220101/actions/synthesizeSpeech",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates an audio for the given input text based on other input parameters like language, voice type, etc.\n"
        },
        {
          "info": {
            "name": "Gets a list of all Customizations in a compartment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://$SWAGGER_HOST_URL/20220101/customizations",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ID of the compartment in which to list resources."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources that match the entire display name given."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Unique identifier(OCID)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n"
              }
            ]
          },
          "docs": "Returns a list of Customizations.\n"
        },
        {
          "info": {
            "name": "Creates a new Customization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://$SWAGGER_HOST_URL/20220101/customizations",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new Customization.\n"
        },
        {
          "info": {
            "name": "Get Customization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://$SWAGGER_HOST_URL/20220101/customizations/:customizationId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customizationId",
                "value": "",
                "type": "path",
                "description": "Unique Customization training Job identifier."
              }
            ]
          },
          "docs": "Gets a Customization by identifier"
        },
        {
          "info": {
            "name": "Update the Customization identified by the id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://$SWAGGER_HOST_URL/20220101/customizations/:customizationId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customizationId",
                "value": "",
                "type": "path",
                "description": "Unique Customization training Job identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a Customization by identifier"
        },
        {
          "info": {
            "name": "Delete Customization and its metadata from tenancy.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://$SWAGGER_HOST_URL/20220101/customizations/:customizationId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customizationId",
                "value": "",
                "type": "path",
                "description": "Unique Customization training Job identifier."
              }
            ]
          },
          "docs": "Delete Customization and its metadata from tenancy."
        },
        {
          "info": {
            "name": "ChangeCustomizationCompartment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://$SWAGGER_HOST_URL/20220101/customizations/:customizationId/actions/changeCompartment",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customizationId",
                "value": "",
                "type": "path",
                "description": "Unique Customization training Job identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Moves a Customization resource into a different compartment."
        },
        {
          "info": {
            "name": "Gets a list of all Transcription Jobs in a compartment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://$SWAGGER_HOST_URL/20220101/transcriptionJobs",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ID of the compartment in which to list resources."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources that match the entire display name given."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Unique identifier(OCID)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n"
              }
            ]
          },
          "docs": "Returns a list of Transcription Jobs.\n"
        },
        {
          "info": {
            "name": "Creates a new Transcription Job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://$SWAGGER_HOST_URL/20220101/transcriptionJobs",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new Transcription Job.\n"
        },
        {
          "info": {
            "name": "Get Transcription Job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://$SWAGGER_HOST_URL/20220101/transcriptionJobs/:transcriptionJobId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transcriptionJobId",
                "value": "",
                "type": "path",
                "description": "Unique Transcription Job identifier."
              }
            ]
          },
          "docs": "Gets a Transcription Job by identifier"
        },
        {
          "info": {
            "name": "Update the Transcription Job identified by the id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://$SWAGGER_HOST_URL/20220101/transcriptionJobs/:transcriptionJobId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transcriptionJobId",
                "value": "",
                "type": "path",
                "description": "Unique Transcription Job identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the Transcription Job"
        },
        {
          "info": {
            "name": "Delete API cleans job, tasks and the related metadata. However the generated transcriptions in customer tenancy will not be deleted.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://$SWAGGER_HOST_URL/20220101/transcriptionJobs/:transcriptionJobId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transcriptionJobId",
                "value": "",
                "type": "path",
                "description": "Unique Transcription Job identifier."
              }
            ]
          },
          "docs": "Delete API cleans job, tasks and the related metadata. However the generated transcriptions in customer tenancy will not be deleted."
        },
        {
          "info": {
            "name": "Canceling the job cancels all the tasks under it.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://$SWAGGER_HOST_URL/20220101/transcriptionJobs/:transcriptionJobId/actions/cancel",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transcriptionJobId",
                "value": "",
                "type": "path",
                "description": "Unique Transcription Job identifier."
              }
            ]
          },
          "docs": "Canceling the job cancels all the tasks under it."
        },
        {
          "info": {
            "name": "ChangeTranscriptionJobCompartment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://$SWAGGER_HOST_URL/20220101/transcriptionJobs/:transcriptionJobId/actions/changeCompartment",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transcriptionJobId",
                "value": "",
                "type": "path",
                "description": "Unique Transcription Job identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Moves a transcription Job resource into a different compartment."
        },
        {
          "info": {
            "name": "Gets a list of all Transcription Task in Transcription Job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://$SWAGGER_HOST_URL/20220101/transcriptionJobs/:transcriptionJobId/transcriptionTasks",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transcriptionJobId",
                "value": "",
                "type": "path",
                "description": "Unique Transcription Job identifier."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources that match the entire display name given."
              },
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Unique identifier(OCID)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'ASC' or 'DESC'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n"
              }
            ]
          },
          "docs": "Returns a list of Transcription Tasks.\n"
        },
        {
          "info": {
            "name": "Get Transcription Task",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://$SWAGGER_HOST_URL/20220101/transcriptionJobs/:transcriptionJobId/transcriptionTasks/:transcriptionTaskId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transcriptionJobId",
                "value": "",
                "type": "path",
                "description": "Unique Transcription Job identifier."
              },
              {
                "name": "transcriptionTaskId",
                "value": "",
                "type": "path",
                "description": "Unique Transcription Task identifier."
              }
            ]
          },
          "docs": "Gets a Transcription Task by identifier"
        },
        {
          "info": {
            "name": "Cancel Transcription Task.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://$SWAGGER_HOST_URL/20220101/transcriptionJobs/:transcriptionJobId/transcriptionTasks/:transcriptionTaskId/actions/cancel",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transcriptionJobId",
                "value": "",
                "type": "path",
                "description": "Unique Transcription Job identifier."
              },
              {
                "name": "transcriptionTaskId",
                "value": "",
                "type": "path",
                "description": "Unique Transcription Task identifier."
              }
            ]
          },
          "docs": "Cancel Transcription Task"
        },
        {
          "info": {
            "name": "Gets a list of speakers available",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://$SWAGGER_HOST_URL/20220101/voices",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ID of the compartment in which to list resources."
              },
              {
                "name": "modelName",
                "value": "",
                "type": "query",
                "description": "The model name to filter voices for given model name."
              },
              {
                "name": "languageCode",
                "value": "",
                "type": "query",
                "description": "The Code or Id of the language to filter voices for given language code."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "The name of the speaker voice in which the user wants tts inference to be."
              }
            ]
          },
          "docs": "Returns a list of speakers available to the user to choose from based on language code and voice type provided.\n"
        }
      ]
    }
  ],
  "bundled": true
}