Transcribe

Access

Requires an authenticated, active account. Instance policy and the operation-specific checks below still apply.

Accepted input and failure modes

audio.content must contain nonempty audio bytes, base64-encoded in REST JSON. audio.uri is declared but rejected by this implementation. The application limit is 25 MiB before provider-specific limits; Gemini inline processing is more restrictive. Missing transcription configuration fails a precondition. Provider/network failures are surfaced as errors rather than saved transcripts. The only successful output is text; store it in a memo separately if desired.

Request

Transcribe transcribes an audio file using an instance AI provider.

Parameters

No path or query parameters are declared.

Request body

Required

application/json · TranscribeRequest

Responses

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

{
  "tags": [
    "AIService"
  ],
  "description": "Transcribe transcribes an audio file using an instance AI provider.",
  "operationId": "AIService_Transcribe",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/TranscribeRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/TranscribeResponse"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}