Gladia API

https://docs.gladia.io/api-reference
Admin
Gladia API provides a state-of-the-art REST API for speech transcription, offering features like...
Tokens:38,362
Snippets:176
Trust Score:9.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Recording JSON Payload

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Example JSON structure for the start_recording lifecycle event.

```json
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-19T12:34:05Z",
  "type": "start_recording"
}
```

--------------------------------

### Speech Start Event Example

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Payload structure for indicating the beginning of speech activity on a specific audio channel.

```json
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-19T12:34:06Z",
  "type": "speech_start",
  "data": {
    "time": 1.24,
    "channel": 0
  }
}
```

--------------------------------

### Start Session

Source: https://docs.gladia.io/api-reference/v2/live/websocket

This message contains the information about the start session of the audio chunk.

```APIDOC
## Start Session

### Description
This message contains the information about the start session of the audio chunk, emitted once when the session is created and ready.

### Payload
- **session_id** (string) - Required - UUID identifying the session.
- **created_at** (string) - Required - ISO 8601 timestamp in UTC.
- **type** (string) - Required - Lifecycle event emitted once when the session is created and ready (const: start_session).

### Example
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-19T12:34:00Z",
  "type": "start_session"
}
```

--------------------------------

### Live Job ID Example

Source: https://docs.gladia.io/api-reference/v2/live/delete

Example value for the required path parameter representing the live job ID.

```text
"45463597-20b7-4af7-b3b3-f5fb778203ab"
```

--------------------------------

### Word-level Timing Example

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Example of a JSON object representing word-level timing and confidence data.

```json
{
  "word": "hello",
  "start": 0.12,
  "end": 0.38,
  "confidence": 0.97
}
```

--------------------------------

### Chapterization Message Example

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Example JSON payload for a post-chapterization message containing session metadata and chapter results.

```json
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-19T12:46:00Z",
  "type": "post_chapterization",
  "error": null,
  "data": {
    "results": [
      {
        "headline": "Project kickoff",
        "start": 0,
        "end": 60,
        "keywords": [
          "timeline",
          "owner"
        ]
      }
    ]
  }
}
```

--------------------------------

### Realtime Transcript Update Example

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Example of a JSON object representing a real-time transcript update message.

```json
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-19T12:34:10Z"
}
```

--------------------------------

### Summarization Message Example

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Example JSON payload for a post-summarization message containing session details and the generated summary.

```json
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-19T12:47:00Z",
  "type": "post_summarization",
  "error": null,
  "data": {
    "results": "The team aligned on goals and next steps for the quarter."
  }
}
```

--------------------------------

### Error Response Examples

Source: https://docs.gladia.io/api-reference/v2/live/delete

Examples of error responses returned when a request fails due to invalid parameters or a missing resource.

```json
{
  "timestamp": "2023-12-28T09:04:17.210Z",
  "path": "/v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab",
  "request_id": "G-821fe9df",
  "statusCode": 403,
  "message": "Invalid parameter"
}
```

```json
{
  "timestamp": "2023-12-28T09:04:17.210Z",
  "path": "/v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab",
  "request_id": "G-821fe9df",
  "statusCode": 404,
  "message": "Not found"
}
```

--------------------------------

### Start Session JSON

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Represents the lifecycle event emitted when a session is successfully created and ready.

```json
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-19T12:34:00Z",
  "type": "start_session"
}
```

--------------------------------

### Get Live Job Metadata via OpenAPI

Source: https://docs.gladia.io/api-reference/v2/live/get

Defines the GET /v2/live/{id} endpoint for retrieving live job status and results.

```yaml
openapi: 3.1.0
info:
  title: Gladia Control API
  description: ''
  version: '1.0'
  contact: {}
servers:
  - url: https://api.gladia.io/
    description: Gladia API production URL
security: []
tags: []
paths:
  /v2/live/{id}:
    get:
      tags:
        - Live V2
      summary: Get the live job's metadata
      operationId: StreamingController_getStreamingJob_v2
      parameters:
        - name: id
          required: true
          in: path
          description: Id of the live job
          schema:
            example: 45463597-20b7-4af7-b3b3-f5fb778203ab
            type: string
      responses:
        '200':
          description: The live job's metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamingResponse'
        '401':
          description: You don't have the permissions to access the live job
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '404':
          description: The live job doesn't exist or has been deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorResponse'
      security:
        - x_gladia_key: []
components:
  schemas:
    StreamingResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the job
          format: uuid
          example: 45463597-20b7-4af7-b3b3-f5fb778203ab
        request_id:
          type: string
          description: Debug id
          example: G-45463597
        version:
          type: integer
          description: API version
          example: 2
        status:
          type: string
          description: >-
            "queued": the job has been queued. "processing": the job is being
            processed. "done": the job has been processed and the result is
            available. "error": an error occurred during the job's processing.
          enum:
            - queued
            - processing
            - done
            - error
        created_at:
          type: string
          description: Creation date
          format: date-time
          example: '2023-12-28T09:04:17.210Z'
        completed_at:
          type: string
          description: Completion date when status is "done" or "error"
          format: date-time
          example: '2023-12-28T09:04:37.210Z'
          nullable: true
        custom_metadata:
          type: object
          description: Custom metadata given in the initial request
          example:
            user: John Doe
          additionalProperties: true
        error_code:
          type: integer
          description: HTTP status code of the error if status is "error"
          minimum: 400
          maximum: 599
          example: 500
          nullable: true
        post_session_metadata:
          type: object
          description: For debugging purposes, send data that could help to identify issues
        kind:
          type: string
          enum:
            - live
          example: live
          default: live
        file:
          description: The file data you uploaded. Can be null if status is "error"
          nullable: true
          allOf:
            - $ref: '#/components/schemas/FileResponse'
        request_params:
          description: >-
            Parameters used for this live transcription. Can be null if status
            is "error"
          nullable: true
          allOf:
            - $ref: '#/components/schemas/StreamingRequestParamsResponse'
        result:
          description: Live transcription's result when status is "done"
          nullable: true
          allOf:
            - $ref: '#/components/schemas/StreamingTranscriptionResultWithMessagesDTO'
      required:
        - id
        - request_id
        - version
        - status
        - created_at
        - post_session_metadata
        - kind
    UnauthorizedErrorResponse:
      type: object
      properties:
        timestamp:
          type: string
          description: Date of when the error occurred
          example: '2023-12-28T09:04:17.210Z'
        path:
          type: string
          description: Path to the API endpoint
          example: /v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab
        request_id:
          type: string
          description: Debug id
          example: G-821fe9df
        statusCode:
          type: number
          description: HTTP status code of the error
          example: 401
        message:
          type: string
          description: Error message
```

--------------------------------

### Final transcript JSON example

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Represents the aggregated output for a session, including metadata and the full transcript.

```json
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-19T12:45:00Z",
  "type": "post_final_transcript",
  "data": {
    "metadata": {
      "audio_duration": 123.45,
      "number_of_distinct_channels": 1,
      "billing_time": 120,
      "transcription_time": 3.2
    },
    "transcription": {
      "full_transcript": "hello world"
    }
  }
}
```

--------------------------------

### Speech Start Message

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Indicates the start of detected speech activity on a given channel.

```APIDOC
## WebSocket Message: Speech Start

### Description
Indicates the start of detected speech activity on a given channel.

### Payload
- **session_id** (string) - Required - UUID identifying the session.
- **created_at** (string) - Required - ISO 8601 timestamp in UTC.
- **type** (string) - Required - Must be 'speech_start'.
- **data** (object) - Required - Timing information for speech start events.
  - **time** (number) - Optional - Time in seconds from session start when the event occurred.
  - **channel** (integer) - Optional - Audio channel index (0-based).

### Example
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-19T12:34:06Z",
  "type": "speech_start",
  "data": {
    "time": 1.24,
    "channel": 0
  }
}
```

--------------------------------

### Translation Message Example

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Example payload structure for a translation message received via WebSocket.

```json
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-19T12:34:20Z",
  "type": "translation",
  "error": null,
  "data": {
    "utterance_id": "utt_001",
    "utterance": {
      "text": "buenos días",
      "language": "es",
      "start": 4.2,
      "end": 6.1
    },
    "original_language": "es",
    "target_language": "en",
    "translated_utterance": {
      "text": "good morning",
      "language": "en",
      "start": 4.2,
      "end": 6.1
    }
  }
}
```

--------------------------------

### OpenAPI Specification for Get Pre-recorded Job

Source: https://docs.gladia.io/api-reference/v2/pre-recorded/get

Defines the GET endpoint for retrieving job metadata and the associated response schemas.

```yaml
openapi: 3.1.0
info:
  title: Gladia Control API
  description: ''
  version: '1.0'
  contact: {}
servers:
  - url: https://api.gladia.io/
    description: Gladia API production URL
security: []
tags: []
paths:
  /v2/pre-recorded/{id}:
    get:
      tags:
        - Pre-recorded V2
      summary: Get the pre recorded job's metadata
      operationId: PreRecordedController_getPreRecordedJob_v2
      parameters:
        - name: id
          required: true
          in: path
          description: Id of the pre recorded job
          schema:
            example: 45463597-20b7-4af7-b3b3-f5fb778203ab
            type: string
      responses:
        '200':
          description: The pre recorded job's metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreRecordedResponse'
        '401':
          description: You don't have the permissions to access the pre recorded job
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '404':
          description: The pre recorded job doesn't exist or has been deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorResponse'
      security:
        - x_gladia_key: []
components:
  schemas:
    PreRecordedResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the job
          format: uuid
          example: 45463597-20b7-4af7-b3b3-f5fb778203ab
        request_id:
          type: string
          description: Debug id
          example: G-45463597
        version:
          type: integer
          description: API version
          example: 2
        status:
          type: string
          description: >-
            "queued": the job has been queued. "processing": the job is being
            processed. "done": the job has been processed and the result is
            available. "error": an error occurred during the job's processing.
          enum:
            - queued
            - processing
            - done
            - error
        created_at:
          type: string
          description: Creation date
          format: date-time
          example: '2023-12-28T09:04:17.210Z'
        completed_at:
          type: string
          description: Completion date when status is "done" or "error"
          format: date-time
          example: '2023-12-28T09:04:37.210Z'
          nullable: true
        custom_metadata:
          type: object
          description: Custom metadata given in the initial request
          example:
            user: John Doe
          additionalProperties: true
        error_code:
          type: integer
          description: HTTP status code of the error if status is "error"
          minimum: 400
          maximum: 599
          example: 500
          nullable: true
        post_session_metadata:
          type: object
          description: For debugging purposes, send data that could help to identify issues
        kind:
          type: string
          enum:
            - pre-recorded
          example: pre-recorded
          default: pre-recorded
        file:
          description: The file data you uploaded. Can be null if status is "error"
          nullable: true
          allOf:
            - $ref: '#/components/schemas/FileResponse'
        request_params:
          description: >-
            Parameters used for this pre-recorded transcription. Can be null if
            status is "error"
          nullable: true
          allOf:
            - $ref: '#/components/schemas/PreRecordedRequestParamsResponse'
        result:
          description: Pre-recorded transcription's result when status is "done"
          nullable: true
          allOf:
            - $ref: '#/components/schemas/TranscriptionResultDTO'
      required:
        - id
        - request_id
        - version
        - status
        - created_at
        - post_session_metadata
        - kind
    UnauthorizedErrorResponse:
      type: object
      properties:
        timestamp:
          type: string
          description: Date of when the error occurred
          example: '2023-12-28T09:04:17.210Z'
        path:
          type: string
          description: Path to the API endpoint
          example: /v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab
        request_id:
          type: string
          description: Debug id
          example: G-821fe9df
        statusCode:
          type: number
          description: HTTP status code of the error
```

--------------------------------

### POST /v2/live

Source: https://docs.gladia.io/api-reference/v2/live/init

Initiates a new live audio processing job. This endpoint allows you to start a real-time transcription session by providing details about the audio stream and processing preferences.

```APIDOC
## POST /v2/live

### Description
Initiates a new live job for audio processing.

### Method
POST

### Endpoint
https://api.gladia.io/v2/live

### Parameters
#### Query Parameters
- **region** (string) - Optional - The region used to process the audio. Supported values: `us-west`, `eu-west`.

#### Request Body
- **encoding** (string) - Optional - The encoding format of the audio stream. Supported formats: PCM (8, 16, 24, 32 bits), A-law (8 bits), μ-law (8 bits). Default: `wav/pcm`.
- **bit_depth** (integer) - Optional - The bit depth of the audio stream. Default: `16`.
- **sample_rate** (integer) - Optional - The sample rate of the audio stream. Default: `16000`.
- **channels** (integer) - Optional - The number of channels of the audio stream. Minimum: `1`, Maximum: `8`. Default: `1`.
- **custom_metadata** (object) - Optional - Custom metadata you can attach to this live transcription.
- **model** (string) - Optional - The model used to process the audio. Default: `solaria-1`.
- **endpointing** (number) - Optional - The endpointing duration in seconds. Default: `0.05`.
- **maximum_duration_without_endpointing** (number) - Optional - The maximum duration in seconds without endpointing. Default: `5`.
- **language_config** (object) - Optional - Specify the language configuration.
- **pre_processing** (object) - Optional - Specify the pre-processing configuration.
- **realtime_processing** (object) - Optional - Specify the realtime processing configuration.
- **post_processing** (object) - Optional - Specify the post-processing configuration.
- **messages_config** (object) - Optional - Specify the websocket messages configuration.
- **callback** (boolean) - Optional - If true, messages will be sent to configured url. Default: `false`.

### Request Example
```json
{
  "encoding": "wav/pcm",
  "sample_rate": 16000,
  "channels": 1,
  "custom_metadata": {
    "user": "John Doe"
  },
  "model": "solaria-1",
  "endpointing": 0.05,
  "maximum_duration_without_endpointing": 5,
  "language_config": {},
  "pre_processing": {},
  "realtime_processing": {},
  "post_processing": {},
  "messages_config": {},
  "callback": false
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the live job.
- **status** (string) - The status of the live job.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "initiated"
}
```

#### Error Responses
- **400** - Bad Request: Something is wrong with the request.
- **401** - Unauthorized: You don't have the permissions to initiate a new live job.
- **422** - Unprocessable Entity: The parameters you gave are incorrect.
```

--------------------------------

### GET /v2/live

Source: https://docs.gladia.io/api-reference/v2/live/list

Retrieve a list of live transcription jobs based on optional filtering and pagination parameters.

```APIDOC
## GET /v2/live

### Description
Get live jobs based on query parameters.

### Method
GET

### Endpoint
/v2/live

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - The starting point for pagination. A value of 0 starts from the first item. Default: 0.
- **limit** (integer) - Optional - The maximum number of items to return. Default: 20.
- **date** (string) - Optional - Filter items relevant to a specific date in ISO format (YYYY-MM-DD).
- **before_date** (string) - Optional - Include items that occurred before the specified date in ISO format.
- **after_date** (string) - Optional - Filter for items after the specified date. Date in ISO format.
- **status** (array) - Optional - Filter the list based on item status. Accepts: queued, processing, done, error.
- **custom_metadata** (object) - Optional - Filter by custom metadata.

### Response
#### Success Response (200)
- **first** (string) - URL to fetch the first page
- **current** (string) - URL to fetch the current page
- **next** (string) - URL to fetch the next page
- **items** (array) - List of live transcriptions

#### Error Response (401)
- **timestamp** (string) - Date of when the error occurred
- **path** (string) - Path to the API endpoint
- **request_id** (string) - Debug id
- **statusCode** (number) - HTTP status code of the error
- **message** (string) - Error message
```

--------------------------------

### OpenAPI Specification for GET /v2/live

Source: https://docs.gladia.io/api-reference/v2/live/list

Defines the request parameters and response schema for listing live transcription jobs.

```yaml
openapi: 3.1.0
info:
  title: Gladia Control API
  description: ''
  version: '1.0'
  contact: {}
servers:
  - url: https://api.gladia.io/
    description: Gladia API production URL
security: []
tags: []
paths:
  /v2/live:
    get:
      tags:
        - Live V2
      summary: Get live jobs based on query parameters
      operationId: StreamingController_getStreamingJobs_v2
      parameters:
        - name: offset
          required: false
          in: query
          description: >-
            The starting point for pagination. A value of 0 starts from the
            first item.
          schema:
            minimum: 0
            default: 0
            type: integer
        - name: limit
          required: false
          in: query
          description: >-
            The maximum number of items to return. Useful for pagination and
            controlling data payload size.
          schema:
            minimum: 1
            default: 20
            type: integer
        - name: date
          required: false
          in: query
          description: Filter items relevant to a specific date in ISO format (YYYY-MM-DD).
          schema:
            format: date-time
            example: '2026-07-29'
            type: string
        - name: before_date
          required: false
          in: query
          description: Include items that occurred before the specified date in ISO format.
          schema:
            format: date-time
            example: '2026-07-29T15:20:24.378Z'
            type: string
        - name: after_date
          required: false
          in: query
          description: >-
            Filter for items after the specified date. Use with `before_date`
            for a range. Date in ISO format.
          schema:
            format: date-time
            example: '2026-07-29T15:20:24.378Z'
            type: string
        - name: status
          required: false
          in: query
          description: >-
            Filter the list based on item status. Accepts multiple values from
            the predefined list.
          schema:
            example:
              - done
            type: array
            items:
              type: string
              enum:
                - queued
                - processing
                - done
                - error
        - name: custom_metadata
          required: false
          in: query
          schema:
            additionalProperties: true
            example:
              user: John Doe
            type: object
      responses:
        '200':
          description: A list of live jobs matching the parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListStreamingResponse'
        '401':
          description: You don't have the permissions to access live jobs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
      security:
        - x_gladia_key: []
components:
  schemas:
    ListStreamingResponse:
      type: object
      properties:
        first:
          type: string
          description: URL to fetch the first page
          format: uri
          example: https://api.gladia.io/v2/transcription?status=done&offset=0&limit=20
        current:
          type: string
          description: URL to fetch the current page
          format: uri
          example: https://api.gladia.io/v2/transcription?status=done&offset=0&limit=20
        next:
          type: string
          description: URL to fetch the next page
          format: uri
          example: >-
            https://api.gladia.io/v2/transcription?status=done&offset=20&limit=20
          nullable: true
        items:
          description: List of live transcriptions
          type: array
          items:
            $ref: '#/components/schemas/StreamingResponse'
      required:
        - first
        - current
        - next
        - items
    UnauthorizedErrorResponse:
      type: object
      properties:
        timestamp:
          type: string
          description: Date of when the error occurred
          example: '2023-12-28T09:04:17.210Z'
        path:
          type: string
          description: Path to the API endpoint
          example: /v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab
        request_id:
          type: string
          description: Debug id
          example: G-821fe9df
        statusCode:
          type: number
          description: HTTP status code of the error
          example: 401
        message:
          type: string
          description: Error message
```

--------------------------------

### GET /v2/live/{id}

Source: https://docs.gladia.io/api-reference/v2/live/get

Retrieves the metadata for a specific live transcription job.

```APIDOC
## GET /v2/live/{id}

### Description
Get the live job's metadata, including its status, parameters, and results.

### Method
GET

### Endpoint
/v2/live/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Id of the live job

### Response
#### Success Response (200)
- **id** (string) - Id of the job
- **request_id** (string) - Debug id
- **version** (integer) - API version
- **status** (string) - Job status (queued, processing, done, error)
- **created_at** (string) - Creation date
- **completed_at** (string) - Completion date
- **custom_metadata** (object) - Custom metadata
- **error_code** (integer) - HTTP status code if status is error
- **post_session_metadata** (object) - Debugging data
- **kind** (string) - Job kind
- **file** (object) - File data
- **request_params** (object) - Parameters used for transcription
- **result** (object) - Transcription result

#### Error Response (401)
- **timestamp** (string) - Date of error
- **path** (string) - API path
- **request_id** (string) - Debug id
- **statusCode** (number) - 401
- **message** (string) - Error message

#### Error Response (404)
- **timestamp** (string) - Date of error
- **path** (string) - API path
- **request_id** (string) - Debug id
- **statusCode** (number) - 404
- **message** (string) - Error message
```

--------------------------------

### Post Transcript Message Example

Source: https://docs.gladia.io/api-reference/v2/live/websocket

JSON structure representing the post-transcript payload containing session details and the full transcript.

```json
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-19T12:40:00Z",
  "type": "post_transcript",
  "data": {
    "full_transcript": "hello world"
  }
}
```

--------------------------------

### End Recording JSON Payload

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Example JSON structure for the end_recording lifecycle event.

```json
{

```

--------------------------------

### Error Response Examples

Source: https://docs.gladia.io/api-reference/v2/live/delete

JSON structures returned when a request fails with 401, 403, or 404 status codes.

```json
{
  "timestamp": "2023-12-28T09:04:17.210Z",
  "path": "/v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab",
  "request_id": "G-821fe9df",
  "statusCode": 401,
  "message": "gladia key not found"
}
```

```json
{
  "timestamp": "2023-12-28T09:04:17.210Z",
  "path": "/v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab",
  "request_id": "G-821fe9df",
  "statusCode": 403,
  "message": "Invalid parameter"
}
```

```json
{
  "timestamp": "2023-12-28T09:04:17.210Z",
  "path": "/v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab",
  "request_id": "G-821fe9df",
  "statusCode": 404,
  "message": "Not found"
}
```

--------------------------------

### Audio Chunk Acknowledgment JSON

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Example of the JSON structure returned when an audio chunk is successfully received and buffered.

```json
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2025-09-19T12:34:56Z",
  "type": "audio_chunk",
  "acknowledged": true,
  "error": null,
  "data": {
    "byte_range": [
      0,
      4095
    ],
    "time_range": [
      0,
      0.256
    ]
  }
}
```

--------------------------------

### OpenAPI Specification for GET /v2/pre-recorded

Source: https://docs.gladia.io/api-reference/v2/pre-recorded/list

The OpenAPI definition for the pre-recorded transcription listing endpoint, including query parameters and response schemas.

```yaml
openapi: 3.1.0
info:
  title: Gladia Control API
  description: ''
  version: '1.0'
  contact: {}
servers:
  - url: https://api.gladia.io/
    description: Gladia API production URL
security: []
tags: []
paths:
  /v2/pre-recorded:
    get:
      tags:
        - Pre-recorded V2
      summary: Get pre recorded jobs based on query parameters
      operationId: PreRecordedController_getPreRecordedJobs_v2
      parameters:
        - name: offset
          required: false
          in: query
          description: >-
            The starting point for pagination. A value of 0 starts from the
            first item.
          schema:
            minimum: 0
            default: 0
            type: integer
        - name: limit
          required: false
          in: query
          description: >-
            The maximum number of items to return. Useful for pagination and
            controlling data payload size.
          schema:
            minimum: 1
            default: 20
            type: integer
        - name: date
          required: false
          in: query
          description: Filter items relevant to a specific date in ISO format (YYYY-MM-DD).
          schema:
            format: date-time
            example: '2026-07-29'
            type: string
        - name: before_date
          required: false
          in: query
          description: Include items that occurred before the specified date in ISO format.
          schema:
            format: date-time
            example: '2026-07-29T15:20:24.378Z'
            type: string
        - name: after_date
          required: false
          in: query
          description: >-
            Filter for items after the specified date. Use with `before_date`
            for a range. Date in ISO format.
          schema:
            format: date-time
            example: '2026-07-29T15:20:24.378Z'
            type: string
        - name: status
          required: false
          in: query
          description: >-
            Filter the list based on item status. Accepts multiple values from
            the predefined list.
          schema:
            example:
              - done
            type: array
            items:
              type: string
              enum:
                - queued
                - processing
                - done
                - error
        - name: custom_metadata
          required: false
          in: query
          schema:
            additionalProperties: true
            example:
              user: John Doe
            type: object
      responses:
        '200':
          description: A list of pre recorded jobs matching the parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPreRecordedResponse'
        '401':
          description: You don't have the permissions to access pre recorded jobs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
      security:
        - x_gladia_key: []
components:
  schemas:
    ListPreRecordedResponse:
      type: object
      properties:
        first:
          type: string
          description: URL to fetch the first page
          format: uri
          example: https://api.gladia.io/v2/transcription?status=done&offset=0&limit=20
        current:
          type: string
          description: URL to fetch the current page
          format: uri
          example: https://api.gladia.io/v2/transcription?status=done&offset=0&limit=20
        next:
          type: string
          description: URL to fetch the next page
          format: uri
          example: >-
            https://api.gladia.io/v2/transcription?status=done&offset=20&limit=20
          nullable: true
        items:
          description: List of pre-recorded transcriptions
          type: array
          items:
            $ref: '#/components/schemas/PreRecordedResponse'
      required:
        - first
        - current
        - next
        - items
    UnauthorizedErrorResponse:
      type: object
      properties:
        timestamp:
          type: string
          description: Date of when the error occurred
          example: '2023-12-28T09:04:17.210Z'
        path:
          type: string
          description: Path to the API endpoint
          example: /v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab
        request_id:
          type: string
          description: Debug id
          example: G-821fe9df
        statusCode:
          type: number
          description: HTTP status code of the error
          example: 401
```

--------------------------------

### Post Transcript Data Structure

Source: https://docs.gladia.io/api-reference/v2/live/websocket

Example of the data object returned in a post_transcript message, containing the full transcript, language information, sentence results, subtitles, and utterance timing.

```yaml
full_transcript: hello world
languages:
  - en
sentences:
  - success: true
    is_empty: false
    exec_time: 0.11
    error: null
    results:
      - Hello world.
subtitles:
  - format: srt
    subtitles: |
      1
      00:00:00,000 --> 00:00:01,000
      Hello world
utterances:
  - start: 0
    end: 0.9
    text: hello world
```

--------------------------------

### OpenAPI Specification for Downloading Audio

Source: https://docs.gladia.io/api-reference/v2/transcription/get-audio

This OpenAPI specification defines the GET /v2/transcription/{id}/file endpoint. Use this to understand the request parameters, expected responses, and potential error codes when downloading an audio file.

```yaml
GET /v2/transcription/{id}/file
openapi: 3.1.0
info:
  title: Gladia Control API
  description: ''
  version: '1.0'
  contact: {}
servers:
  - url: https://api.gladia.io/
    description: Gladia API production URL
security: []
tags: []
paths:
  /v2/transcription/{id}/file:
    get:
      tags:
        - Transcription V2
      summary: Download the audio file used for this transcription job
      operationId: TranscriptionController_getAudio_v2
      parameters:
        - name: id
          required: true
          in: path
          description: Id of the transcription job
          schema:
            example: 45463597-20b7-4af7-b3b3-f5fb778203ab
            type: string
      responses:
        '200':
          description: The audio file used for this transcription job
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                example: <binary>
        '401':
          description: >-
            You don't have the permissions to access this transcription job or
            its audio file
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '404':
          description: >-
            The transcription job or its audio file doesn't exist or has been
            deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorResponse'
      security:
        - x_gladia_key: []
components:
  schemas:
    UnauthorizedErrorResponse:
      type: object
      properties:
        timestamp:
          type: string
          description: Date of when the error occurred
          example: '2023-12-28T09:04:17.210Z'
        path:
          type: string
          description: Path to the API endpoint
          example: /v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab
        request_id:
          type: string
          description: Debug id
          example: G-821fe9df
        statusCode:
          type: number
          description: HTTP status code of the error
          example: 401
        message:
          type: string
          description: Error message
          example: gladia key not found
      required:
        - timestamp
        - path
        - request_id
        - statusCode
        - message
    NotFoundErrorResponse:
      type: object
      properties:
        timestamp:
          type: string
          description: Date of when the error occurred
          example: '2023-12-28T09:04:17.210Z'
        path:
          type: string
          description: Path to the API endpoint
          example: /v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab
        request_id:
          type: string
          description: Debug id
          example: G-821fe9df
        statusCode:
          type: number
          description: HTTP status code of the error
          example: 404
        message:
          type: string
          description: Error message
          example: Not found
      required:
        - timestamp
        - path
        - request_id
        - statusCode
        - message
  securitySchemes:
    x_gladia_key:
      type: apiKey
      in: header
      name: x-gladia-key
      description: Your personal Gladia API key

```

--------------------------------

### Authenticate API Calls with API Key

Source: https://docs.gladia.io/api-reference/authentication

Use your API key in the 'x-gladia-key' header to authenticate all API requests. This method is universally applicable across all environments.

```bash
curl --request GET \
  --url https://api.gladia.io/v2/transcription \
  --header 'x-gladia-key: YOUR_GLADIA_API_KEY'
```

--------------------------------

### Download Live Audio File (OpenAPI)

Source: https://docs.gladia.io/api-reference/v2/live/get-audio

Use this OpenAPI definition to understand the request and response structure for downloading live audio. Ensure you include your API key in the request headers.

```yaml
GET /v2/live/{id}/file
openapi: 3.1.0
info:
  title: Gladia Control API
  description: ''
  version: '1.0'
  contact: {}
servers:
  - url: https://api.gladia.io/
    description: Gladia API production URL
security: []
tags: []
paths:
  /v2/live/{id}/file:
    get:
      tags:
        - Live V2
      summary: Download the audio file used for this live job
      operationId: StreamingController_getAudio_v2
      parameters:
        - name: id
          required: true
          in: path
          description: Id of the live job
          schema:
            example: 45463597-20b7-4af7-b3b3-f5fb778203ab
            type: string
      responses:
        '200':
          description: The audio file used for this live job
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                example: <binary>
        '401':
          description: >-
            You don't have the permissions to access this live job or its audio
            file
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '404':
          description: The live job or its audio file doesn't exist or has been deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorResponse'
      security:
        - x_gladia_key: []
components:
  schemas:
    UnauthorizedErrorResponse:
      type: object
      properties:
        timestamp:
          type: string
          description: Date of when the error occurred
          example: '2023-12-28T09:04:17.210Z'
        path:
          type: string
          description: Path to the API endpoint
          example: /v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab
        request_id:
          type: string
          description: Debug id
          example: G-821fe9df
        statusCode:
          type: number
          description: HTTP status code of the error
          example: 401
        message:
          type: string
          description: Error message
          example: gladia key not found
      required:
        - timestamp
        - path
        - request_id
        - statusCode
        - message
    NotFoundErrorResponse:
      type: object
      properties:
        timestamp:
          type: string
          description: Date of when the error occurred
          example: '2023-12-28T09:04:17.210Z'
        path:
          type: string
          description: Path to the API endpoint
          example: /v2/transcription/45463597-20b7-4af7-b3b3-f5fb778203ab
        request_id:
          type: string
          description: Debug id
          example: G-821fe9df
        statusCode:
          type: number
          description: HTTP status code of the error
          example: 404
        message:
          type: string
          description: Error message
          example: Not found
      required:
        - timestamp
        - path
        - request_id
        - statusCode
        - message
  securitySchemes:
    x_gladia_key:
      type: apiKey
      in: header
      name: x-gladia-key
      description: Your personal Gladia API key

```
Tokens:
Raw