redaction [offline]

Not supported yet.

This documentation is valid for the following list of our models:

• #g1_redaction

Note:

Previously, our STT models operated via a single API call to POST https://api.aimlapi.com/v1/stt. You can view the API schema here.

Now, we are switching to a new two-step process:

• POST https://api.aimlapi.com/v1/stt/create – Creates and submits a speech-to-text processing task to the server. This method accepts the same parameters as the old version but returns a generation_id instead of the final transcript.

• GET https://api.aimlapi.com/v1/stt/{generation_id} – Retrieves the generated transcript from the server using the generation_id obtained from the previous API call.

This approach helps prevent generation failures due to timeouts. We've prepared a couple of examples below to make the transition to the new STT API easier for you.

Model Overview

Model removes sensitive information (credit cards info, personally identifiable information, account numbers, etc) from your transcripts.

Setup your API Key

If you don’t have an API key for the AI/ML API yet, feel free to use our Quickstart guide.

Submit a request

API Schema

Creating and sending a speech-to-text conversion task to the server

post

/v1/stt/create

Authorizations

Body

any of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.aimlapi.com/v1/stt/create' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "#g1_nova-2-general",
    "custom_intent": "text",
    "custom_topic": "text",
    "custom_intent_mode": "strict",
    "custom_topic_mode": "strict",
    "detect_language": true,
    "detect_entities": true,
    "detect_topics": true,
    "diarize": true,
    "dictation": true,
    "diarize_version": "text",
    "extra": "text",
    "filler_words": true,
    "intents": true,
    "keywords": "text",
    "language": "text",
    "measurements": true,
    "multi_channel": true,
    "numerals": true,
    "paragraphs": true,
    "profanity_filter": true,
    "punctuate": true,
    "search": "text",
    "sentiment": true,
    "smart_format": true,
    "summarize": "text",
    "tag": [
      "text"
    ],
    "topics": true,
    "utterances": true,
    "utt_split": 1
  }'

201

201

{
  "generation_id": "123e4567-e89b-12d3-a456-426614174000"
}

Requesting the result of the task from the server using the generation_id

get

/v1/stt/{generation_id}

Authorizations

Path parameters

generation_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.aimlapi.com/v1/stt/{generation_id}' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>'

201

201

{
  "status": "text",
  "result": {
    "metadata": {
      "transaction_key": "text",
      "request_id": "text",
      "sha256": "text",
      "created": "2025-03-15T23:08:28.967Z",
      "duration": 1,
      "channels": 1,
      "models": [
        "text"
      ],
      "model_info": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": "text",
          "version": "text",
          "arch": "text"
        }
      }
    }
  }
}