> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentscope.io/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> For AgentScope Python, use https://docs.agentscope.io/stable/en/index for new projects. For existing projects, check the installed agentscope version and use matching versioned documentation.
> The /latest/ alias points to the newest documentation and may move ahead of /stable/ when a development version exists. Do not mix AgentScope 1.x and 2.x APIs.
> State the AgentScope version when providing installation commands or code examples. ReMe uses its own continuously updated /reme/latest/ documentation.

# Transcribe an uploaded audio recording

> Transcribe one complete browser recording with a batch ASR model.

Args:
    file (`UploadFile`):
        The uploaded audio recording. Files larger than 25 MiB are
        rejected.
    credential_id (`str`):
        The stored credential used to call the ASR provider.
    model (`str`):
        The batch ASR model name.
    parameters (`str`):
        Provider-specific parameters encoded as a JSON object.
    user_id (`str`):
        The authenticated viewer's user ID.
    access (`ResourceAccessService`):
        The service used to authorize and resolve the credential.

Returns:
    `TranscriptionResponse`:
        The recognized text.

Raises:
    `HTTPException`:
        If the upload is empty or too large, the parameters are invalid,
        or the credential and model cannot be used by the viewer.



## OpenAPI

````yaml /en/versions/2.0.12/deploy/openapi.json post /asr/transcriptions
openapi: 3.1.0
info:
  title: AgentScope
  version: 2.0.12
servers: []
security: []
paths:
  /asr/transcriptions:
    post:
      tags:
        - asr
      summary: Transcribe an uploaded audio recording
      description: |-
        Transcribe one complete browser recording with a batch ASR model.

        Args:
            file (`UploadFile`):
                The uploaded audio recording. Files larger than 25 MiB are
                rejected.
            credential_id (`str`):
                The stored credential used to call the ASR provider.
            model (`str`):
                The batch ASR model name.
            parameters (`str`):
                Provider-specific parameters encoded as a JSON object.
            user_id (`str`):
                The authenticated viewer's user ID.
            access (`ResourceAccessService`):
                The service used to authorize and resolve the credential.

        Returns:
            `TranscriptionResponse`:
                The recognized text.

        Raises:
            `HTTPException`:
                If the upload is empty or too large, the parameters are invalid,
                or the credential and model cannot be used by the viewer.
      operationId: transcribe_audio_asr_transcriptions_post
      parameters:
        - name: x-user-id
          in: header
          required: true
          schema:
            type: string
            description: >-
              Caller's user ID. Temporary header-based identity; will be
              replaced by JWT auth.
            title: X-User-Id
          description: >-
            Caller's user ID. Temporary header-based identity; will be replaced
            by JWT auth.
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: >-
                #/components/schemas/Body_transcribe_audio_asr_transcriptions_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TranscriptionResponse'
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Body_transcribe_audio_asr_transcriptions_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
        credential_id:
          type: string
          title: Credential Id
        model:
          type: string
          title: Model
        parameters:
          type: string
          title: Parameters
          default: '{}'
      type: object
      required:
        - file
        - credential_id
        - model
      title: Body_transcribe_audio_asr_transcriptions_post
    TranscriptionResponse:
      properties:
        text:
          type: string
          title: Text
          description: The transcribed text.
      type: object
      required:
        - text
      title: TranscriptionResponse
      description: Text returned after transcribing an uploaded audio file.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.