---
title: "Convert Speech to Text using AI"
method: POST
path: "/api/ai/speech-text"
tags: ["AI Services"]
---

# Convert Speech to Text using AI

`POST /api/ai/speech-text`

## Request

- Base URL: `https://api.worqhat.com`
- URL: `https://api.worqhat.com/api/ai/speech-text`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/docs/api/ai/speech-text/post.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint is used to convert speech to text using AI. It accepts a Form Data containing the audio file and returns the the speech to text conversion results.

## Request body `multi-part/form-data`

- object
  - `audio` string, binary: The audio file to be sent as input. The audio file can be of any format.

## Response `200`

Successful response

- object
  - `status` string: Status indicating the success of the Audio Conversion Process. In case you have an error for `multipart/form-data` requests, try removing the `Content-Type` header.
  - `data` object
    - `text` string: The Extracted Text from the Audio.
    - `speaker_labels` unknown[]
      - unknown
  - `processing_time` integer: The time taken to process the request, in milliseconds.
  - `processing_id` string: A universally unique identifier for the request. This can be used to track the request in the logs.
  - `processing_count` integer: The number of times the request has been processed. This is what is considered in the Billing Process. This is either the number of times the image is processed or the number of words that the server processes.

## Other responses

- `400`: Bad Request. This mostly happens because of invalid image sizes. Neither `height` nor `width` of the image should be less than 128px. Only one of the sides of the image should be greater than or equal to 512px. (Eg: 512x512, 512x768, 768x512) Maximum dimensions supported is 512x896.
- `401`: Unauthorized
- `404`: Not Found
- `406`: Not Acceptable
- `500`: Internal Server Error

## Changes

- **2023-11-03** `4dfb38675161`: 1 breaking, 2 info
  - the `data` response's property type changed from `string` to `object` for status `200`
  - added the optional property `data/speaker_labels` to the response with the `200` status
  - added the optional property `data/text` to the response with the `200` status
- **2023-10-20** `871850b7231f`: 1 breaking, 3 warning, 17 info
  - removed the media type `multipart/form-data` from the request body
  - removed the optional property `content` from the response with the `200` status
  - removed the optional property `id` from the response with the `200` status
  - removed the optional property `timestamp` from the response with the `200` status
  - …17 more
- **2023-08-15** `b5ffe2a9748f`: 5 breaking, 15 info
  - the response's body type changed from no type to `object` for status `200`
  - the response's body type changed from no type to `object` for status `400`
  - the response's body type changed from no type to `object` for status `401`
  - the response's body type changed from no type to `object` for status `404`
  - …16 more
- **2023-08-04** `be85a8f8fc8c`: 5 breaking, 13 warning
  - the response's body type changed from `object` to no type for status `200`
  - the response's body type changed from `object` to no type for status `400`
  - the response's body type changed from `object` to no type for status `401`
  - the response's body type changed from `object` to no type for status `404`
  - …14 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/changes/api/ai/speech-text/post.md)

---

[API](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2.md) - [All operations](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/llms.txt) - [OpenAPI document](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/revisions/fc369f69a3e6?raw)
