TechSpecs API

https://techspecs.readme.io
Admin
TechSpecs API provides fast and easy access to official technical specifications of consumer...
Tokens:43,348
Snippets:246
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Success Response Example

Source: https://techspecs.readme.io/reference/audio-upload

This is an example of a successful response after uploading an audio file.

```json
{
  "message": "File uploaded successfully in 123.45 ms and processing started",
  "email": "user@example.com",  
  "upload_time_ms": 123.45 
}
```

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

### Get Product Detail

Source: https://techspecs.readme.io/reference/product-detail

Fetches the detailed specifications for a given product ID.

```APIDOC
## GET /v5/products/{product_id}

### Description
Retrieves the detailed specifications of a product by providing its unique product ID.

### Method
GET

### Endpoint
/v5/products/{product_id}

### Parameters
#### Path Parameters
- **product_id** (string) - Required - Product ID

#### Query Parameters
- **lang** (string) - Required - Language (default: en)
- **keepCasing** (boolean) - Optional - Whether to keep the casing of product attributes

#### Header Parameters
- **Accept-Encoding** (string) - Optional - Default: gzip, deflate
- **x-api-id** (string) - Required - Your API ID can be obtained from your dashboard
- **x-api-key** (string) - Required - Your API key can be obtained from your dashboard

### Response
#### Success Response (200)
- **(object)** - Product details

#### Error Response (400)
- **(object)** - Error details
```

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

### Get Product Images

Source: https://techspecs.readme.io/reference/get-product-images

Fetches product images for a given product ID. The response includes URLs for different image sizes.

```APIDOC
## GET /products/{productId}/images

### Description
Retrieves a list of image URLs for a specific product, available in different resolutions.

### Method
GET

### Endpoint
/products/{productId}/images

### Parameters
#### Path Parameters
- **productId** (string) - Required - The unique identifier of the product.

### Response
#### Success Response (200)
- **images** (object) - Contains URLs for different image sizes.
  - **thumbnail** (string) - URL for the thumbnail size image.
  - **small** (string) - URL for the small size image.
  - **medium** (string) - URL for the medium size image.
  - **large** (string) - URL for the large size image.
  - **large_2** (string) - URL for the large_2 size image.
  - **large_3** (string) - URL for the large_3 size image.
  - **large_4** (string) - URL for the large_4 size image.

#### Response Example
```json
{
  "images": {
    "thumbnail": "<https://i.techspecs.io/product-images-thumbnail/smartphones/7-1864acdcb7c1.jpeg>",
    "small": "<https://i.techspecs.io/product-images-small/smartphones/26517e0e-4e78-4347-b434-45acba7121ef.jpeg>",
    "medium": "<https://i.techspecs.io/product-images-medium/smartphones/ede4f1eb-1fb1-4e09-8540-9bf0c47e87b4.jpeg>",
    "large": "<https://i.techspecs.io/product-images-large/smartphones/2f11a9ee-f2d6-4edd-a8b7-c9a00d937d5e.jpeg>",
    "large_2": "<https://i.techspecs.io/product-images-large/smartphones/26517e0e-4e78-4347-b434-45acba7121ef.jpeg>",
    "large_3": "<https://i.techspecs.io/product-images-large/smartphones/ede4f1eb-1fb1-4e09-8540-9bf0c47e87b4.jpeg>",
    "large_4": "<https://i.techspecs.io/product-images-large/smartphones/2f11a9ee-f2d6-4edd-a8b7-c9a00d937d5e.jpeg>"
  }
}
```
```

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

### Get Product Schema OpenAPI Definition

Source: https://techspecs.readme.io/reference/add-a-product

This is the OpenAPI definition for the 'Get Product Schema' endpoint. It outlines the request parameters, including API ID, API key, category, and language, as well as the possible responses.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "TechSpecs API",
    "version": "5.0"
  },
  "servers": [
    {
      "url": "https://api.techspecs.io"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/v5/products/schema": {
      "get": {
        "summary": "Get Product Schema",
        "description": "This endpoint allows you to retrieve the product schema for a specified product category.",
        "operationId": "add-a-product",
        "parameters": [
          {
            "name": "x-api-id",
            "in": "header",
            "description": "Your API ID is available on your dashboard",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "category",
            "in": "query",
            "description": "Enter a valid product category",
            "schema": {
              "type": "string",
              "default": "Smartphones"
            }
          },
          {
            "name": "x-api-key",
            "in": "header",
            "description": "Your API Key is available on your dashboard",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "lang",
            "in": "query",
            "description": "The language",
            "schema": {
              "type": "string",
              "default": "en"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "667b1901d44238005b5d69c6:667b1901d44238005b5d69e4"
}
```

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

### Get All Brands

Source: https://techspecs.readme.io/reference/all-brands-1

Retrieves a list of all brands supported by the system. This includes details such as the brand name, website, and various logo formats.

```APIDOC
## GET /brands

### Description
Retrieves a list of all brands.

### Method
GET

### Endpoint
/brands

### Response
#### Success Response (200)
- **Success** (integer) - Indicates if the request was successful.
- **message** (string) - A message describing the result of the request.
- **error** (object) - An object containing error details if the request failed.
- **data** (object) - An object containing the list of brands.
  - **data** (array) - An array of brand objects.
    - **brand** (object) - Details about the brand.
      - **name** (string) - The name of the brand.
      - **website** (string) - The website URL of the brand.
    - **logo** (object) - Information about the brand's logo in different formats.
      - **jpg** (string) - URL for the JPG logo.
      - **pdf** (string) - URL for the PDF logo.
      - **png** (string) - URL for the PNG logo.
      - **svg** (string) - URL for the SVG logo.
      - **tiff** (string) - URL for the TIFF logo.
    - **_id** (string) - The unique identifier for the brand entry.
    - **__v** (integer) - Version information for the brand entry.

### Response Example
```json
{
  "Success": 1,
  "message": "All brands",
  "error": {},
  "data": {
    "data": [
      {
        "brand": {
          "name": "Samsung",
          "website": "samsung.com"
        },
        "logo": {
          "jpg": "",
          "pdf": "",
          "png": "",
          "svg": "",
          "tiff": ""
        },
        "_id": "628e50161d92fdeeb74a37cf",
        "__v": 0
      }
    ]
  }
}
```
```

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

### Get All Products

Source: https://techspecs.readme.io/reference/product-search-get-all-products

Retrieves a list of products based on specified search criteria. Supports filtering by release date, category, and brand, along with pagination.

```APIDOC
## GET /v5/products/search/

### Description
Retrieves a list of products based on specified search criteria. Supports filtering by release date, category, and brand, along with pagination.

### Method
GET

### Endpoint
/v5/products/search/

### Parameters
#### Header Parameters
- **x-api-id** (string) - Required - Your API ID can be obtained from your dashboard
- **x-api-key** (string) - Required - Your API key can be obtained from your dashboard

#### Query Parameters
- **category** (string) - Optional - Product category ex Smartphones, Tablets etc. Leave blank to search all categories
- **brand** (string) - Optional - Product brand ex Apple, Samsung etc. Leave blank to search all brands
- **keepCasing** (boolean) - Optional - when set to true, the attribute will maintain its original casing, while setting it to false will convert the attribute to lower case. (default: true)
- **page** (string) - Required - Page number for pagination (default: "0")
- **size** (string) - Optional - Number of results per page (default: "10")
- **from** (string) - Optional - Release date filter (default: "2010-01-01")
- **to** (string) - Optional - Release date filter (default: "2024-01-01")

### Response
#### Success Response (200)
- **Success** (number) - Indicates if the request was successful.
- **message** (string) - A message describing the result of the request.
- **error** (object) - An object containing error details, if any.
- **data** (object) - An object containing the search results and metadata.
  - **meta** (object) - Metadata about the search results.
    - **alerts** (array) - List of alerts.
    - **warnings** (array) - List of warnings.
    - **page** (object) - Pagination information.
      - **current** (number) - The current page number.
      - **total_pages** (number) - The total number of pages available.
      - **total_results** (number) - The total number of results found.
      - **size** (number) - The number of results per page.
    - **engine** (object) - Information about the search engine used.
      - **name** (string) - The name of the search engine.
      - **type** (string) - The type of the search engine.
    - **request_id** (string) - The unique identifier for the request.
  - **results** (array) - An array of matched product objects.

#### Response Example (200)
```json
{
    "Success": 1,
    "message": "product matched",
    "error": {},
    "data": {
        "meta": {
            "alerts": [],
            "warnings": [],
            "page": {
                "current": number,
                "total_pages": number,
                "total_results": number,
                "size": number
            },
            "engine": {
                "name": "engine_name",
                "type": "engine_default"
            },
            "request_id": "request_id"
        },
        "results": [
          {matched_product_objects}
        ]
    }
}
```

#### Error Response (400)
```json
{
    "Result": {}
}
```
```

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

### POST /translations/subtitles Request Example

Source: https://techspecs.readme.io/reference/endpoint-for-fetching-subtitles

This JSON object demonstrates the required parameters for requesting translated subtitles. Ensure all fields, including email, key, and content_id, are correctly provided.

```json
{
  "email": "user@example.com",
  "key": "your_api_key",
  "content_id": "content123",  
  "language": "Spanish",
  "format": "json",
  "revised": false
}
```

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

### Get All Brand Logos

Source: https://techspecs.readme.io/reference/get-all-brand-logos-copy

Retrieves a list of all brands and their associated logos.

```APIDOC
## GET /brands/logos

### Description
Retrieves a list of all brands and their associated logos.

### Method
GET

### Endpoint
/brands/logos

### Response
#### Success Response (200)
- **Success** (integer) - Indicates if the request was successful.
- **message** (string) - A message describing the result of the request.
- **error** (object) - An object containing error details if the request failed.
- **data** (object)
  - **data** (array) - An array of brand logo objects.
    - **brand** (object)
      - **name** (string) - The name of the brand.
      - **website** (string) - The website of the brand.
    - **logo** (object)
      - **jpg** (string) - URL or path to the JPG logo.
      - **pdf** (string) - URL or path to the PDF logo.
      - **png** (string) - URL or path to the PNG logo.
      - **svg** (string) - URL or path to the SVG logo.
      - **tiff** (string) - URL or path to the TIFF logo.
    - **_id** (string) - The unique identifier for the brand logo entry.
    - **__v** (integer) - The version number of the brand logo entry.

#### Response Example
```json
{
    "Success": 1,
    "message": "All brands",
    "data": {
        "data": [
            {
                "brand": {
                    "name": "Samsung",
                    "website": "samsung.com"
                },
                "logo": {
                    "jpg": "",
                    "pdf": "",
                    "png": "",
                    "svg": "",
                    "tiff": ""
                },
                "_id": "628e50161d92fdeeb74a37cf",
                "__v": 0
            }
        ]
    }
}
```
```

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

### Get Product Images

Source: https://techspecs.readme.io/reference/get-product-images

Retrieves all available product images for a specified product. You can optionally include the product image gallery in the response.

```APIDOC
## GET /v5/products/{product_id}/images

### Description
This endpoint allows you to retrieve all available product images for a specified product.

### Method
GET

### Endpoint
/v5/products/{product_id}/images

### Parameters
#### Path Parameters
- **product_id** (string) - Required - Product ID

#### Query Parameters
- **includeGallery** (boolean) - Optional - Whether to include the product image gallery. Defaults to true.

#### Header Parameters
- **x-api-id** (string) - Required - Your API ID is available on your dashboard
- **x-api-key** (string) - Required - Your API Key is available on your dashboard

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code.
- **message** (string) - A message indicating the success of the operation.
- **data** (object) - Contains the product and image data.
  - **data** (object)
    - **product** (object) - Details about the product.
      - **category** (string)
      - **brand** (string)
      - **model** (string)
      - **available_colors** (string)
      - **release_date** (string)
      - **id** (string)
    - **colors** (array) - An array of objects, each representing a color variant with its images.
      - **color** (string)
      - **images** (object)
        - **jpg** (string) - URL for the JPG image.
        - **avif** (string) - URL for the AVIF image.
        - **color_hex** (string) - Hexadecimal color code.
    - **gallery** (object) - Contains thumbnail and large image URLs for the product gallery.
```

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

### OpenAPI Definition for Get All Categories

Source: https://techspecs.readme.io/reference/all-categories

This OpenAPI definition describes the `/v5/categories` GET endpoint. It specifies required headers like 'x-api-id' and 'x-api-key', and optional query parameters for pagination ('page', 'size'). The success response includes a list of categories.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "TechSpecs API",
    "version": "5.0"
  },
  "servers": [
    {
      "url": "https://api.techspecs.io"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/v5/categories": {
      "get": {
        "summary": "Get All Categories",
        "description": "This endpoint allows you to retrieve all available product categories.",
        "operationId": "all-categories",
        "parameters": [
          {
            "name": "x-api-id",
            "in": "header",
            "description": "Your API ID is available on your dashboard",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "x-api-key",
            "in": "header",
            "description": "Your API Key is available on your dashboard",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "The page number for pagination",
            "schema": {
              "type": "string",
              "default": "0"
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "The number of results per page",
            "schema": {
              "type": "string",
              "default": "10"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{    \n  \"Success\": 1,\n    \"message\": \"Category list\",\n    \"error\": {},
    \"data\": {\n        \"Category\": [category_list]\n    }\n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "667b1901d44238005b5d69c6:667b1901d44238005b5d69d0"
}
```

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

### POST /translations/subtitles Response Example

Source: https://techspecs.readme.io/reference/endpoint-for-fetching-subtitles

This JSON object shows a successful response when fetching translated subtitles. It includes status, language, translation details, and the captions themselves.

```json
{
  "status": "success",
  "message": "Captions fetched successfully",
  "language": "Spanish",
  "translated": true,
  "revised": false,
  "completion_percentage": 100,
  "captions": {
    "1": {
      "start_time": "00:00:01,000",
      "end_time": "00:00:04,000",
      "text": "Hola, ¿cómo estás?"
    },
    "2": {
      "start_time": "00:00:05,000",
      "end_time": "00:00:07,000",
      "text": "Bienvenido a bordo."
    }
  }
}
```

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

### Get All Categories

Source: https://techspecs.readme.io/reference/all-categories

This endpoint retrieves a list of all available product categories. You can control the pagination using the 'page' and 'size' query parameters.

```APIDOC
## GET /v5/categories

### Description
This endpoint allows you to retrieve all available product categories.

### Method
GET

### Endpoint
/v5/categories

### Parameters
#### Header Parameters
- **x-api-id** (string) - Required - Your API ID is available on your dashboard
- **x-api-key** (string) - Required - Your API Key is available on your dashboard

#### Query Parameters
- **page** (string) - Optional - The page number for pagination (default: "0")
- **size** (string) - Optional - The number of results per page (default: "10")

### Response
#### Success Response (200)
- **Success** (integer) - Indicates if the request was successful.
- **message** (string) - A message describing the result.
- **error** (object) - An object containing error details, if any.
- **data** (object) - An object containing the category list.
  - **Category** (array) - A list of product categories.

#### Response Example (200)
```json
{
  "Success": 1,
  "message": "Category list",
  "error": {},
  "data": {
    "Category": [category_list]
  }
}
```
```

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

### Get Product Schema

Source: https://techspecs.readme.io/reference/add-a-product

This endpoint allows you to retrieve the product schema for a specified product category.

```APIDOC
## GET /v5/products/schema

### Description
This endpoint allows you to retrieve the product schema for a specified product category.

### Method
GET

### Endpoint
/v5/products/schema

### Parameters
#### Header Parameters
- **x-api-id** (string) - Required - Your API ID is available on your dashboard
- **x-api-key** (string) - Required - Your API Key is available on your dashboard

#### Query Parameters
- **category** (string) - Optional - Enter a valid product category (default: Smartphones)
- **lang** (string) - Optional - The language (default: en)

### Response
#### Success Response (200)
- **(object)** - Description for the response body

#### Response Example
```json
{
  "example": "{}"
}
```
```

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

### Get All Brands

Source: https://techspecs.readme.io/reference/all-brands

This endpoint allows you to retrieve all available product brands for a specified product category.

```APIDOC
## GET /v5/brands

### Description
This endpoint allows you to retrieve all available product brands for a specified product category.

### Method
GET

### Endpoint
https://api.techspecs.io/v5/brands

### Parameters
#### Query Parameters
- **category** (string) - Required - The category parameter is used to filter products by a specific category. By entering a category name, you can retrieve all brands that are associated with that category. (default: Smartphones)
- **page** (string) - Optional - The page number for pagination (default: 0)
- **size** (string) - Optional - The number of results per page (default: 10)

#### Header Parameters
- **x-api-id** (string) - Required - Your API ID is available on your dashboard
- **x-api-key** (string) - Optional - Your API Key is available on your dashboard

### Response
#### Success Response (200)
- **Success** (integer) - Indicates if the request was successful.
- **message** (string) - A message describing the result of the request.
- **error** (object) - An object containing error details if the request failed.
- **data** (object) - An object containing the brand data.
  - **brands** (array) - A list of brand objects.

#### Response Example
```json
{
    "Success": 1,
    "message": "Brand list",
    "error": {},
    "data": {
        "brands": [brand_list]
    }
}
```
```

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

### OpenAPI Brand Logo Definition Example

Source: https://techspecs.readme.io/reference/get-all-brand-logos-copy

This snippet shows a sample of the OpenAPI definition for a brand, including its name, website, and logo attributes. It is part of a larger array of brand objects.

```json
{
                    "brand": {
                    "name": "PalmOne",
                    "website": "palm.com"
                },
                "logo": {
                    "jpg": "",
                    "pdf": "",
                    "png": "",
                    "svg": "",
                    "tiff": ""
                },
                "_id": "628e50181d92fdeeb74a38ea",
                "__v": 0
            }
```

```json
{
                "brand": {
                    "name": "Panasonic",
                    "website": "na.panasonic.com"
                },
                "logo": {
                    "jpg": "",
                    "pdf": "",
                    "png": "",
                    "svg": "",
                    "tiff": ""
                },
                "_id": "628e50181d92fdeeb74a38eb",
                "__v": 0
            }
```

```json
{
                "brand": {
                    "name": "Pantech",
                    "website": "pantech.com"
                },
                "logo": {
                    "jpg": "",
                    "pdf": "",
                    "png": "",
                    "svg": "",
                    "tiff": ""
                },
                "_id": "628e50181d92fdeeb74a38ec",
                "__v": 0
            }
```

```json
{
                "brand": {
                    "name": "Pebble",
                    "website": ""
                },
                "logo": {
                    "jpg": "",
                    "pdf": "",
                    "png": "",
                    "svg": "",
                    "tiff": ""
                },
                "_id": "628e50181d92fdeeb74a38ed",
                "__v": 0
            }
```

```json
{
                "brand": {
                    "name": "Pepsi",
                    "website": "pepsi.com"
                },
                "logo": {
                    "jpg": "",
                    "pdf": "",
                    "png": "",
                    "svg": "",
                    "tiff": ""
                },
                "_id": "628e50181d92fdeeb74a38ee",
                "__v": 0
            }
```

```json
{
                "brand": {
                    "name": "Pharos",
                    "website": "pharos.com"
                },
                "logo": {
                    "jpg": "",
                    "pdf": "",
                    "png": "",
                    "svg": "",
                    "tiff": ""
                },
                "_id": "628e50181d92fdeeb74a38ef",
                "__v": 0
            }
```

```json
{
                "brand": {
                    "name": "Philips",
                    "website": "philips.com"
                },
                "logo": {
                    "jpg": "",
                    "pdf": "",
                    "png": "",
                    "svg": "",
                    "tiff": ""
                },
                "_id": "628e50181d92fdeeb74a38f0",
                "__v": 0
            }
```

```json
{
                "brand": {
                    "name": "PiPO",
                    "website": "pipo.com"
                },
                "logo": {
                    "jpg": "",
                    "pdf": "",
                    "png": "",
                    "svg": "",
                    "tiff": ""
                },
                "_id": "628e50181d92fdeeb74a38f1",
                "__v": 0
            }
```

```json
{
                "brand": {
                    "name": "Pioneer",
                    "website": "pioneer.eu"
                },
                "logo": {
                    "jpg": "",
                    "pdf": "",
                    "png": "",
                    "svg": "",
                    "tiff": ""
                },
                "_id": "628e50181d92fdeeb74a38f2",
                "__v": 0
            }
```

```json
{
                "brand": {
                    "name": "Pixelphone",
                    "website": ""
                },
                "logo": {
                    "jpg": "",
                    "pdf": "",
                    "png": "",
                    "svg": "",
                    "tiff": ""
                },
                "_id": "628e50181d92fdeeb74a38f3",
                "__v": 0
            }
```

```json
{
                "brand": {
                    "name": "Planet Computers",
                    "website": "www3.planetcom."
                }
```

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

### OpenAPI Definition for Get All Brands

Source: https://techspecs.readme.io/reference/all-brands

This OpenAPI definition outlines the structure and parameters for the Get All Brands API endpoint. It includes details on request parameters like category, API ID, API key, pagination, and possible responses.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "TechSpecs API",
    "version": "5.0"
  },
  "servers": [
    {
      "url": "https://api.techspecs.io"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/v5/brands": {
      "get": {
        "summary": "Get All Brands",
        "description": "This endpoint allows you to retrieve all available product brands for a specified product category.",
        "operationId": "all-brands",
        "parameters": [
          {
            "name": "category",
            "in": "query",
            "description": "The category parameter is used to filter products by a specific category. By entering a category name, you can retrieve all brands that are associated with that category.",
            "required": true,
            "schema": {
              "type": "string",
              "default": "Smartphones"
            }
          },
          {
            "name": "x-api-id",
            "in": "header",
            "description": "Your API ID is available on your dashboard",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "x-api-key",
            "in": "header",
            "description": "Your API Key is available on your dashboard",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "The page number for pagination",
            "schema": {
              "type": "string",
              "default": "0"
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "The number of results per page",
            "schema": {
              "type": "string",
              "default": "10"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{    \"Success\": 1,\n    \"message\": \"Brand list\",\n    \"error\": {},
    \"data\": {
        \"brands\": [brand_list]\n    }
}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "667b1901d44238005b5d69c6:667b1901d44238005b5d69d1"
}
```

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

### Product Images OpenAPI Definition

Source: https://techspecs.readme.io/reference/get-product-images

This snippet shows the OpenAPI definition for the product images endpoint. It includes the schema for successful responses, detailing different image sizes like 'thumbnail', 'medium', and 'large' with their respective URLs. It also defines the structure for error responses.

```json
{
  "paths": {
    "/products/{productId}/images": {
      "get": {
        "summary": "Get product images",
        "operationId": "getProductImage",
        "parameters": [
          {
            "name": "productId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "data": {
                        "images": {
                          "thumbnail": "<https://i.techspecs.io/product-images-thumbnail/smartphones/26517e0e-4e78-4347-b434-45acba7121ef.jpeg>",
                          "medium": "<https://i.techspecs.io/product-images-medium/smartphones/26517e0e-4e78-4347-b434-45acba7121ef.jpeg>",
                          "large_1": "<https://i.techspecs.io/product-images-large/smartphones/26517e0e-4e78-4347-b434-45acba7121ef.jpeg>",
                          "large_2": "<https://i.techspecs.io/product-images-large/smartphones/26517e0e-4e78-4347-b434-45acba7121ef.jpeg>",
                          "large_3": "<https://i.techspecs.io/product-images-large/smartphones/ede4f1eb-1fb1-4e09-8540-9bf0c47e87b4.jpeg>",
                          "large_4": "<https://i.techspecs.io/product-images-large/smartphones/2f11a9ee-f2d6-4edd-a8b7-c9a00d937d5e.jpeg>"
                        }
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "images": {
                          "type": "object",
                          "properties": {
                            "thumbnail": {
                              "type": "string"
                            },
                            "medium": {
                              "type": "string"
                            },
                            "large_1": {
                              "type": "string"
                            },
                            "large_2": {
                              "type": "string"
                            },
                            "large_3": {
                              "type": "string"
                            },
                            "large_4": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "667b1901d44238005b5d69c6:667b1901d44238005b5d69f9"
}
```

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

### Get All Brand Logos

Source: https://techspecs.readme.io/reference/get-all-brand-logos-copy

This endpoint allows you to retrieve all available logos for a specified brand.

```APIDOC
## Get All Brand Logos

### Description
This endpoint allows you to retrieve all available logos for a specified brand.

### Method
GET

### Endpoint
/brands/{brandId}/logos

### Parameters
#### Path Parameters
- **brandId** (string) - Required - The unique identifier of the brand.

### Response
#### Success Response (200)
- **logos** (array) - A list of logo objects, each containing properties like url, format, and size.

#### Response Example
```json
{
  "logos": [
    {
      "url": "https://example.com/logos/brandA_color.png",
      "format": "png",
      "size": "medium"
    },
    {
      "url": "https://example.com/logos/brandA_bw.svg",
      "format": "svg",
      "size": "large"
    }
  ]
}
```
```

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

### OpenAPI Definition for Product Detail

Source: https://techspecs.readme.io/reference/product-detail

This OpenAPI 3.1.0 definition outlines the structure and parameters for the Product Detail API endpoint.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "TechSpecs API",
    "version": "5.0"
  },
  "servers": [
    {
      "url": "https://api.techspecs.io"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/v5/products/{product_id}": {
      "get": {
        "summary": "Product Detail",
        "description": "",
        "operationId": "product-detail",
        "parameters": [
          {
            "name": "Accept-Encoding",
            "in": "header",
            "schema": {
              "type": "string",
              "enum": [
                ""
              ],
              "default": "gzip, deflate"
            }
          },
          {
            "name": "lang",
            "in": "query",
            "description": "Language",
            "required": true,
            "schema": {
              "type": "string",
              "default": "en"
            }
          },
          {
            "name": "product_id",
            "in": "path",
            "description": "Product ID",
            "schema": {
              "type": "string",
              "default": "63e96260ff7af4b68a304765"
            },
            "required": true
          },
          {
            "name": "keepCasing",
            "in": "query",
            "description": "Whether to keep the casing of product attributes",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "x-api-id",
            "in": "header",
            "description": "Your API ID can be obtained from your dashboard",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "x-api-key",
            "in": "header",
            "description": "Your API  key can be obtained from your dashboard",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "667b1901d44238005b5d69c6:667b1901d44238005b5d69e1"
}
```

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

### Upload Audio File

Source: https://techspecs.readme.io/reference/audio-upload

This endpoint allows you to upload an MP3 audio file for processing. It requires your email, an API key, and the audio file itself.

```APIDOC
## POST /v1/audio/process

### Description
Allows developers to upload audio files (specifically MP3) for processing, such as subtitle generation or translation.

### Method
POST

### Endpoint
/v1/audio/process

### Parameters
#### Form Data
- **email** (string) - Required - Email address of the user submitting the request.
- **key** (string) - Required - API key associated with the user's account for authentication.
- **file** (file) - Required - The audio file to be uploaded. Only `.mp3` format is supported.

### Request Example
```text
--boundary
Content-Disposition: form-data; name="email"

user@example.com
--boundary
Content-Disposition: form-data; name="key"

YOUR_API_KEY
--boundary
Content-Disposition: form-data; name="file"; filename="audio.mp3"
Content-Type: audio/mpeg

<binary data>
--boundary--
```

### Response
#### Success Response (200 OK)
- **message** (string) - Confirmation message indicating successful upload and processing start.
- **email** (string) - The email address of the user.
- **upload_time_ms** (number) - The time taken for the upload in milliseconds.

#### Response Example
```json
{
  "message": "File uploaded successfully in 123.45 ms and processing started",
  "email": "user@example.com",  
  "upload_time_ms": 123.45  
}
```

### Error Responses
- **400**: Invalid or missing parameters, file format errors, or usage limits exceeded.
- **403**: Invalid or inactive API key.
- **500**: Internal server errors during processing.
```
Tokens:
Raw