Merge pull request #41 from DeepLcom/aj/AE-412-usage

AE-412: Add speech-to-text usage metrics to API doc

Author: akash-joshi

CHANGELOG.md

@@ -13,6 +13,12 @@ typos, schema fixes, or adding examples.
 ### Added
 * Document `X-Trace-ID` response header returned by all API endpoints for request tracking and debugging
 
+## [3.9.0] - 2025-12-11
+### Added
+* Add `speech_to_text_milliseconds` field to usage reports and analytics components
+* Add `speech_to_text_milliseconds_count` and `speech_to_text_milliseconds_limit` fields to `/v2/usage` response for API Pro users
+* Add `billing_unit`, `api_key_unit_count`, and `account_unit_count` fields to product usage items in `/v2/usage` response
+
 ## [3.8.0] - 2025-11-26
 ### Fixed
 * Fixes/development changes to the voice API. Note that this API is under active develpoment and not yet stable.
@@ -269,7 +275,8 @@ keys within an organization.
 ## [2.0.0]
 Initial release of the OpenAPI specification.
 
-[Unreleased]: https://github.com/DeepLcom/openapi/compare/v3.8.0...HEAD
+[Unreleased]: https://github.com/DeepLcom/openapi/compare/v3.9.0...HEAD
+[3.9.0]: https://github.com/DeepLcom/openapi/compare/v3.8.0...v3.9.0
 [3.8.0]: https://github.com/DeepLcom/openapi/compare/v3.7.0...v3.8.0
 [3.7.0]: https://github.com/DeepLcom/openapi/compare/v3.6.1...v3.7.0
 [3.6.1]: https://github.com/DeepLcom/openapi/compare/v3.6.0...v3.6.1

openapi.json

@@ -2003,17 +2003,33 @@
                       "products": [
                         {
                           "product_type": "write",
+                          "billing_unit": "characters",
+                          "api_key_unit_count": 0,
+                          "account_unit_count": 5643,
                           "api_key_character_count": 0,
                           "character_count": 5643
                         },
                         {
                           "product_type": "translate",
+                          "billing_unit": "characters",
+                          "api_key_unit_count": 636,
+                          "account_unit_count": 5941580,
                           "api_key_character_count": 636,
                           "character_count": 5941580
+                        },
+                        {
+                          "product_type": "speech_to_text",
+                          "billing_unit": "milliseconds",
+                          "api_key_unit_count": 1800000,
+                          "account_unit_count": 1800000,
+                          "api_key_character_count": 0,
+                          "character_count": 0
                         }
                       ],
                       "api_key_character_count": 636,
                       "api_key_character_limit": 1000000000000,
+                      "speech_to_text_milliseconds_count": 1800000,
+                      "speech_to_text_milliseconds_limit": 36000000,
                       "start_time": "2025-05-13T09:18:42Z",
                       "end_time": "2025-06-13T09:18:42Z"
                     }
@@ -3740,6 +3756,25 @@
                   "description": "The type of product (e.g., 'write', 'translate').",
                   "example": "write"
                 },
+                "billing_unit": {
+                  "type": "string",
+                  "enum": [
+                    "characters",
+                    "milliseconds"
+                  ],
+                  "description": "The billing unit for this product type.",
+                  "example": "characters"
+                },
+                "api_key_unit_count": {
+                  "type": "integer",
+                  "description": "Units used for this product by this API key in the current period.",
+                  "example": 0
+                },
+                "account_unit_count": {
+                  "type": "integer",
+                  "description": "Total units used for this product by the account in the current period.",
+                  "example": 5643
+                },
                 "api_key_character_count": {
                   "type": "integer",
                   "description": "Characters used for this product by this API key in the current period.",
@@ -3763,6 +3798,16 @@
             "description": "Only present for API Pro users. Character limit for this API key in the current period.",
             "example": 1000000000000
           },
+          "speech_to_text_milliseconds_count": {
+            "type": "integer",
+            "description": "Only present for API Pro users. Milliseconds of speech-to-text used in the current period.",
+            "example": 1800000
+          },
+          "speech_to_text_milliseconds_limit": {
+            "type": "integer",
+            "description": "Only present for API Pro users. Milliseconds of speech-to-text limit in the current period.",
+            "example": 36000000
+          },
           "start_time": {
             "type": "string",
             "format": "date-time",

openapi.yaml

@@ -1461,13 +1461,27 @@ paths:
                     character_limit: 1000000000000
                     products:
                       - product_type: write
+                        billing_unit: characters
+                        api_key_unit_count: 0
+                        account_unit_count: 5643
                         api_key_character_count: 0
                         character_count: 5643
                       - product_type: translate
+                        billing_unit: characters
+                        api_key_unit_count: 636
+                        account_unit_count: 5941580
                         api_key_character_count: 636
                         character_count: 5941580
+                      - product_type: speech_to_text
+                        billing_unit: milliseconds
+                        api_key_unit_count: 1800000
+                        account_unit_count: 1800000
+                        api_key_character_count: 0
+                        character_count: 0
                     api_key_character_count: 636
                     api_key_character_limit: 1000000000000
+                    speech_to_text_milliseconds_count: 1800000
+                    speech_to_text_milliseconds_limit: 36000000
                     start_time: '2025-05-13T09:18:42Z'
                     end_time: '2025-06-13T09:18:42Z'
         400:
@@ -2918,6 +2932,21 @@ components:
                 type: string
                 description: The type of product (e.g., 'write', 'translate').
                 example: write
+              billing_unit:
+                type: string
+                enum:
+                  - characters
+                  - milliseconds
+                description: The billing unit for this product type.
+                example: characters
+              api_key_unit_count:
+                type: integer
+                description: Units used for this product by this API key in the current period.
+                example: 0
+              account_unit_count:
+                type: integer
+                description: Total units used for this product by the account in the current period.
+                example: 5643
               api_key_character_count:
                 type: integer
                 description: Characters used for this product by this API key in the current period.
@@ -2934,6 +2963,14 @@ components:
           type: integer
           description: Only present for API Pro users. Character limit for this API key in the current period.
           example: 1000000000000
+        speech_to_text_milliseconds_count:
+          type: integer
+          description: Only present for API Pro users. Milliseconds of speech-to-text used in the current period.
+          example: 1800000
+        speech_to_text_milliseconds_limit:
+          type: integer
+          description: Only present for API Pro users. Milliseconds of speech-to-text limit in the current period.
+          example: 36000000
         start_time:
           type: string
           format: date-time