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

# File Encoding Converter API

> Convert text or a file between character encodings — UTF-8, UTF-16, Latin-1, Windows-1252, ISO-8859 variants, Cyrillic, Greek, Shift_JIS, GBK, Big5, EUC-KR and more. Optional BOM, flags characters the target charset can't represent, and downloads the re-encoded bytes.

[Try File Encoding Converter in your browser →](https://iotools.cloud/tool/file-encoding-converter/)



## OpenAPI

````yaml https://api.iotools.cloud/v1/openapi post /v1/tool/file-encoding-converter
openapi: 3.1.0
info:
  title: iotools.cloud API
  version: 1.0.0
  description: >-
    Run any iotools.cloud tool over HTTP.


    Authenticate with `Authorization: Bearer iot_live_…`.


    **Only `POST /v1/tool/{slug}` costs credits.** Every GET here — the catalog,
    a tool's schema, your balance — is free. A tool call is charged its own
    weight or your plan's per-call minimum, whichever is larger;
    `x-iotools-credit-cost` on each operation is quoted at the free-tier
    minimum, and `GET /v1/tools/list` returns the exact figure for your key.
    `GET /v1/me/credits` reports what you have left, and `GET /v1/me/usage`
    reports what it went on.


    Failures are RFC 9457 problem documents — branch on `code`.
servers:
  - url: https://api.iotools.cloud
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Catalog
    description: Find a tool and read its contract. Free.
  - name: Converters
    description: >-
      Convert between formats, encodings, and units — Base64, CSV and JSON,
      timestamps, and more. Fast, free, and processed right in your browser.
  - name: Formatters
    description: >-
      Format, beautify, minify, and validate code and data — JSON, HTML, CSS,
      SQL, and regex. Clean up messy input in one click, with nothing to upload.
  - name: Generators
    description: >-
      Generate exactly what you need and on demand — passwords, UUIDs, QR codes,
      hashes, random numbers, and more. Secure, instant, and free.
  - name: Calculators
    description: >-
      Crunch the numbers fast — from everyday math to specialized conversions
      and unit work. Free online calculators that run entirely in your browser.
  - name: Editors
    description: >-
      Edit and transform text, code, and images with quick, focused editors that
      run entirely in your browser — nothing to install, and no sign-up needed.
  - name: Utilities
    description: >-
      Everyday developer and web utilities — DNS and IP lookups, redirect and
      certificate checkers, and other quick diagnostics. Free and
      privacy-friendly.
  - name: Account
    description: Your key's allowance, limits and usage history.
paths:
  /v1/tool/file-encoding-converter:
    post:
      tags:
        - Converters
      summary: File Encoding Converter
      description: >-
        Convert text or a file between character encodings — UTF-8, UTF-16,
        Latin-1, Windows-1252, ISO-8859 variants, Cyrillic, Greek, Shift_JIS,
        GBK, Big5, EUC-KR and more. Optional BOM, flags characters the target
        charset can't represent, and downloads the re-encoded bytes.


        [Try File Encoding Converter in your browser
        →](https://iotools.cloud/tool/file-encoding-converter/)
      operationId: run_file_encoding_converter
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                inputText:
                  type: string
                  description: Text
                file:
                  type: string
                  contentEncoding: base64
                  description: File (read as raw bytes)
                sourceEncoding:
                  enum:
                    - utf-8
                    - utf-16le
                    - utf-16be
                    - ascii
                    - iso-8859-1
                    - windows-1252
                    - iso-8859-15
                    - iso-8859-2
                    - windows-1250
                    - iso-8859-5
                    - windows-1251
                    - koi8-r
                    - koi8-u
                    - ibm866
                    - iso-8859-7
                    - windows-1253
                    - windows-1254
                    - iso-8859-8
                    - windows-1255
                    - windows-1256
                    - windows-1257
                    - windows-1258
                    - windows-874
                    - macintosh
                    - shift_jis
                    - euc-jp
                    - gbk
                    - big5
                    - euc-kr
                  description: File is currently encoded as
                targetEncoding:
                  enum:
                    - utf-8
                    - utf-16le
                    - utf-16be
                    - ascii
                    - iso-8859-1
                    - windows-1252
                    - iso-8859-15
                    - iso-8859-2
                    - windows-1250
                    - iso-8859-5
                    - windows-1251
                    - koi8-r
                    - koi8-u
                    - ibm866
                    - iso-8859-7
                    - windows-1253
                    - windows-1254
                    - iso-8859-8
                    - windows-1255
                    - windows-1256
                    - windows-1257
                    - windows-1258
                    - windows-874
                    - macintosh
                    - shift_jis
                    - euc-jp
                    - gbk
                    - big5
                    - euc-kr
                  description: Convert to
                addBom:
                  type: boolean
                  description: Add a byte order mark (UTF-8 / UTF-16 only)
                strict:
                  type: boolean
                  description: >-
                    Fail if a character can't be represented (otherwise it
                    becomes ?)
              required: []
            examples:
              text_windows_1252:
                summary: Text → Windows-1252
                value:
                  file: ''
                  sourceEncoding: utf-8
                  targetEncoding: windows-1252
                  addBom: ''
                  strict: ''
                  inputText: Café — naïve “quotes” €5
              windows_1252_file_utf_8:
                summary: Windows-1252 file → UTF-8
                value:
                  file: data:application/octet-stream;base64,k0hplA==
                  sourceEncoding: windows-1252
                  targetEncoding: utf-8
                  addBom: ''
                  strict: ''
                  inputText: ''
              japanese_text_shift_jis:
                summary: Japanese text → Shift_JIS
                value:
                  file: ''
                  sourceEncoding: utf-8
                  targetEncoding: shift_jis
                  addBom: ''
                  strict: ''
                  inputText: 日本語 テキスト
      responses:
        '200':
          description: Tool output
          content:
            application/json:
              examples:
                text_windows_1252:
                  summary: Text → Windows-1252
                  value:
                    tool: file-encoding-converter
                    tool_version: 1.0.2
                    outputs:
                      summary:
                        - property: From
                          value: Pasted text (Unicode)
                        - property: To
                          value: Windows-1252 (Western European)
                        - property: Input size
                          value: 34 bytes
                        - property: Output size
                          value: 24 bytes
                        - property: Characters
                          value: '24'
                        - property: BOM
                          value: None
                        - property: Unmappable characters
                          value: None
                      converted: >-
                        data:text/plain;charset=windows-1252;base64,Q2Fm6SCXIG5h73ZlIJNxdW90ZXOUIIA1
                      preview: Café — naïve “quotes” €5
                      hex: >-
                        43 61 66 E9 20 97 20 6E 61 EF 76 65 20 93 71 75 6F 74 65
                        73 94 20 80 35
                    credits_used: 5
                    credits_remaining: null
                windows_1252_file_utf_8:
                  summary: Windows-1252 file → UTF-8
                  value:
                    tool: file-encoding-converter
                    tool_version: 1.0.2
                    outputs:
                      summary:
                        - property: From
                          value: Windows-1252 (Western European)
                        - property: To
                          value: UTF-8
                        - property: Input size
                          value: 4 bytes
                        - property: Output size
                          value: 8 bytes
                        - property: Characters
                          value: '4'
                        - property: BOM
                          value: None
                        - property: Unmappable characters
                          value: None
                      converted: data:text/plain;charset=utf-8;base64,4oCcSGnigJ0=
                      preview: “Hi”
                      hex: E2 80 9C 48 69 E2 80 9D
                    credits_used: 5
                    credits_remaining: null
                japanese_text_shift_jis:
                  summary: Japanese text → Shift_JIS
                  value:
                    tool: file-encoding-converter
                    tool_version: 1.0.2
                    outputs:
                      summary:
                        - property: From
                          value: Pasted text (Unicode)
                        - property: To
                          value: Shift_JIS (Japanese)
                        - property: Input size
                          value: 22 bytes
                        - property: Output size
                          value: 15 bytes
                        - property: Characters
                          value: '8'
                        - property: BOM
                          value: None
                        - property: Unmappable characters
                          value: None
                      converted: >-
                        data:text/plain;charset=shift_jis;base64,k/qWe4zqIINlg0yDWINn
                      preview: 日本語 テキスト
                      hex: 93 FA 96 7B 8C EA 20 83 65 83 4C 83 58 83 67
                    credits_used: 5
                    credits_remaining: null
              schema:
                type: object
                required:
                  - tool
                  - tool_version
                  - outputs
                  - credits_used
                  - credits_remaining
                properties:
                  outputs:
                    type: object
                    properties:
                      summary:
                        type: array
                        items:
                          type: object
                          properties:
                            property:
                              type: string
                              description: Property
                            value:
                              type: string
                              description: Value
                        x-iotools-columns:
                          - property
                          - value
                      converted:
                        type: string
                        contentEncoding: base64
                        description: Converted file
                      preview:
                        type: string
                        description: Round-trip preview (result decoded back)
                      hex:
                        type: string
                        description: Bytes (hex)
                  tool:
                    type: string
                    description: The tool's slug, echoing the {slug} in the request path.
                  tool_version:
                    type: string
                    description: Output-contract version for this tool.
                  credits_used:
                    type: integer
                    description: >-
                      Credits this call consumed, after any settlement refund. 0
                      when metering is disabled.
                  credits_remaining:
                    type:
                      - integer
                      - 'null'
                    description: >-
                      Credits left in the current monthly allowance, or null
                      when metering is disabled.
                  request_id:
                    type: string
                    description: Correlation id, also sent as x-request-id.
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/InsufficientCredits'
        '403':
          $ref: '#/components/responses/ToolNotAllowed'
        '404':
          $ref: '#/components/responses/ToolNotFound'
        '413':
          $ref: '#/components/responses/PayloadTooLarge'
        '422':
          $ref: '#/components/responses/UnprocessableInput'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ToolFailed'
        '503':
          $ref: '#/components/responses/ToolDisabled'
      security:
        - bearerAuth: []
components:
  responses:
    ValidationError:
      description: Invalid request.
      content:
        application/problem+json:
          schema:
            type: object
            description: >-
              RFC 9457 problem document, served as application/problem+json.
              Branch on `code`; `title` is human prose and may be reworded
              without notice. Some failures add extension members — `fields` on
              validation errors, `retry_after` on 429s,
              `credits_used`/`credits_remaining` on billing-adjacent failures —
              documented on the responses that carry them.
            required:
              - type
              - title
              - status
              - code
            properties:
              type:
                type: string
                format: uri
                description: Stable documentation URI for this failure.
                examples:
                  - https://docs.iotools.cloud/errors/validation_error
              title:
                type: string
                description: Short human-readable summary of the failure.
                examples:
                  - Invalid request
              status:
                type: integer
                description: HTTP status code, matching the response's own status.
              code:
                type: string
                description: >-
                  Stable machine-readable error code — branch on this, not
                  `title`.
                enum:
                  - validation_error
              detail:
                type: string
                description: Human explanation of this occurrence.
              request_id:
                type: string
                description: Correlation id, also sent as x-request-id.
              fields:
                type:
                  - object
                  - string
                additionalProperties:
                  type: string
                description: >-
                  What failed: a map of field name → message. Absent when the
                  body itself is malformed; a single string when the failure
                  isn't tied to one field.
          example:
            type: https://docs.iotools.cloud/errors/validation_error
            title: Invalid request
            status: 400
            code: validation_error
            detail: One or more inputs are invalid — see `fields`.
            request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
            fields:
              inputString: Required
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/problem+json:
          schema:
            type: object
            description: >-
              RFC 9457 problem document, served as application/problem+json.
              Branch on `code`; `title` is human prose and may be reworded
              without notice. Some failures add extension members — `fields` on
              validation errors, `retry_after` on 429s,
              `credits_used`/`credits_remaining` on billing-adjacent failures —
              documented on the responses that carry them.
            required:
              - type
              - title
              - status
              - code
            properties:
              type:
                type: string
                format: uri
                description: Stable documentation URI for this failure.
                examples:
                  - https://docs.iotools.cloud/errors/invalid_api_key
              title:
                type: string
                description: Short human-readable summary of the failure.
                examples:
                  - Invalid API key
              status:
                type: integer
                description: HTTP status code, matching the response's own status.
              code:
                type: string
                description: >-
                  Stable machine-readable error code — branch on this, not
                  `title`.
                enum:
                  - invalid_api_key
              detail:
                type: string
                description: Human explanation of this occurrence.
              request_id:
                type: string
                description: Correlation id, also sent as x-request-id.
          example:
            type: https://docs.iotools.cloud/errors/invalid_api_key
            title: Invalid API key
            status: 401
            code: invalid_api_key
            detail: 'Provide ''Authorization: Bearer <key>''.'
            request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
    InsufficientCredits:
      description: Monthly credit allowance exhausted.
      content:
        application/problem+json:
          schema:
            type: object
            description: >-
              RFC 9457 problem document, served as application/problem+json.
              Branch on `code`; `title` is human prose and may be reworded
              without notice. Some failures add extension members — `fields` on
              validation errors, `retry_after` on 429s,
              `credits_used`/`credits_remaining` on billing-adjacent failures —
              documented on the responses that carry them.
            required:
              - type
              - title
              - status
              - code
            properties:
              type:
                type: string
                format: uri
                description: Stable documentation URI for this failure.
                examples:
                  - https://docs.iotools.cloud/errors/insufficient_credits
                  - >-
                    https://docs.iotools.cloud/errors/vendor_api_tier_limit_exceeded
              title:
                type: string
                description: Short human-readable summary of the failure.
                examples:
                  - Insufficient credits
                  - Free-tier API limit reached for this tool
              status:
                type: integer
                description: HTTP status code, matching the response's own status.
              code:
                type: string
                description: >-
                  Stable machine-readable error code — branch on this, not
                  `title`.
                enum:
                  - insufficient_credits
                  - vendor_api_tier_limit_exceeded
              detail:
                type: string
                description: Human explanation of this occurrence.
              request_id:
                type: string
                description: Correlation id, also sent as x-request-id.
              credits_used:
                type: integer
                description: Always 0 — a refused call charges nothing.
              credits_remaining:
                type: integer
                description: Credits left in the allowance — fewer than this call costs.
          example:
            type: https://docs.iotools.cloud/errors/insufficient_credits
            title: Insufficient credits
            status: 402
            code: insufficient_credits
            detail: This call costs 1 credit and 0 remain in this month's allowance.
            request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
            credits_used: 0
            credits_remaining: 0
    ToolNotAllowed:
      description: Tool exists but has no API surface.
      content:
        application/problem+json:
          schema:
            type: object
            description: >-
              RFC 9457 problem document, served as application/problem+json.
              Branch on `code`; `title` is human prose and may be reworded
              without notice. Some failures add extension members — `fields` on
              validation errors, `retry_after` on 429s,
              `credits_used`/`credits_remaining` on billing-adjacent failures —
              documented on the responses that carry them.
            required:
              - type
              - title
              - status
              - code
            properties:
              type:
                type: string
                format: uri
                description: Stable documentation URI for this failure.
                examples:
                  - https://docs.iotools.cloud/errors/tool_not_allowed
              title:
                type: string
                description: Short human-readable summary of the failure.
                examples:
                  - Tool not available over the API
              status:
                type: integer
                description: HTTP status code, matching the response's own status.
              code:
                type: string
                description: >-
                  Stable machine-readable error code — branch on this, not
                  `title`.
                enum:
                  - tool_not_allowed
              detail:
                type: string
                description: Human explanation of this occurrence.
              request_id:
                type: string
                description: Correlation id, also sent as x-request-id.
          example:
            type: https://docs.iotools.cloud/errors/tool_not_allowed
            title: Tool not available over the API
            status: 403
            code: tool_not_allowed
            detail: >-
              "Background Remover" is available on iotools.cloud but has no API
              endpoint.
            request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
    ToolNotFound:
      description: No such tool.
      content:
        application/problem+json:
          schema:
            type: object
            description: >-
              RFC 9457 problem document, served as application/problem+json.
              Branch on `code`; `title` is human prose and may be reworded
              without notice. Some failures add extension members — `fields` on
              validation errors, `retry_after` on 429s,
              `credits_used`/`credits_remaining` on billing-adjacent failures —
              documented on the responses that carry them.
            required:
              - type
              - title
              - status
              - code
            properties:
              type:
                type: string
                format: uri
                description: Stable documentation URI for this failure.
                examples:
                  - https://docs.iotools.cloud/errors/tool_not_found
              title:
                type: string
                description: Short human-readable summary of the failure.
                examples:
                  - Tool not found
              status:
                type: integer
                description: HTTP status code, matching the response's own status.
              code:
                type: string
                description: >-
                  Stable machine-readable error code — branch on this, not
                  `title`.
                enum:
                  - tool_not_found
              detail:
                type: string
                description: Human explanation of this occurrence.
              request_id:
                type: string
                description: Correlation id, also sent as x-request-id.
          example:
            type: https://docs.iotools.cloud/errors/tool_not_found
            title: Tool not found
            status: 404
            code: tool_not_found
            detail: No tool with that slug. See GET /v1/tools/list.
            request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
    PayloadTooLarge:
      description: Body too large.
      content:
        application/problem+json:
          schema:
            type: object
            description: >-
              RFC 9457 problem document, served as application/problem+json.
              Branch on `code`; `title` is human prose and may be reworded
              without notice. Some failures add extension members — `fields` on
              validation errors, `retry_after` on 429s,
              `credits_used`/`credits_remaining` on billing-adjacent failures —
              documented on the responses that carry them.
            required:
              - type
              - title
              - status
              - code
            properties:
              type:
                type: string
                format: uri
                description: Stable documentation URI for this failure.
                examples:
                  - https://docs.iotools.cloud/errors/payload_too_large
              title:
                type: string
                description: Short human-readable summary of the failure.
                examples:
                  - Payload too large
              status:
                type: integer
                description: HTTP status code, matching the response's own status.
              code:
                type: string
                description: >-
                  Stable machine-readable error code — branch on this, not
                  `title`.
                enum:
                  - payload_too_large
              detail:
                type: string
                description: Human explanation of this occurrence.
              request_id:
                type: string
                description: Correlation id, also sent as x-request-id.
          example:
            type: https://docs.iotools.cloud/errors/payload_too_large
            title: Payload too large
            status: 413
            code: payload_too_large
            detail: Request body exceeds this tool's size limit.
            request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
    UnprocessableInput:
      description: Well-formed request, but there is no result to return.
      content:
        application/problem+json:
          schema:
            type: object
            description: >-
              RFC 9457 problem document, served as application/problem+json.
              Branch on `code`; `title` is human prose and may be reworded
              without notice. Some failures add extension members — `fields` on
              validation errors, `retry_after` on 429s,
              `credits_used`/`credits_remaining` on billing-adjacent failures —
              documented on the responses that carry them.
            required:
              - type
              - title
              - status
              - code
            properties:
              type:
                type: string
                format: uri
                description: Stable documentation URI for this failure.
                examples:
                  - https://docs.iotools.cloud/errors/unprocessable_input
              title:
                type: string
                description: Short human-readable summary of the failure.
                examples:
                  - Input cannot be processed
              status:
                type: integer
                description: HTTP status code, matching the response's own status.
              code:
                type: string
                description: >-
                  Stable machine-readable error code — branch on this, not
                  `title`.
                enum:
                  - unprocessable_input
              detail:
                type: string
                description: Human explanation of this occurrence.
              request_id:
                type: string
                description: Correlation id, also sent as x-request-id.
              credits_used:
                type: integer
                description: >-
                  Always 0 on `unprocessable_input` — a failed run is refunded,
                  floor included.
              credits_remaining:
                type: integer
                description: >-
                  Credits left after the refund. Absent when metering is
                  disabled.
          example:
            type: https://docs.iotools.cloud/errors/unprocessable_input
            title: Input cannot be processed
            status: 422
            code: unprocessable_input
            detail: >-
              This video has no captions or subtitles, so there is no transcript
              to extract.
            request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
            credits_used: 0
    RateLimited:
      description: Per-minute rate limit exceeded.
      headers:
        Retry-After:
          description: Seconds to wait before retrying (RFC 9110 delta-seconds).
          schema:
            type: integer
      content:
        application/problem+json:
          schema:
            type: object
            description: >-
              RFC 9457 problem document, served as application/problem+json.
              Branch on `code`; `title` is human prose and may be reworded
              without notice. Some failures add extension members — `fields` on
              validation errors, `retry_after` on 429s,
              `credits_used`/`credits_remaining` on billing-adjacent failures —
              documented on the responses that carry them.
            required:
              - type
              - title
              - status
              - code
            properties:
              type:
                type: string
                format: uri
                description: Stable documentation URI for this failure.
                examples:
                  - https://docs.iotools.cloud/errors/rate_limited
              title:
                type: string
                description: Short human-readable summary of the failure.
                examples:
                  - Rate limit exceeded
              status:
                type: integer
                description: HTTP status code, matching the response's own status.
              code:
                type: string
                description: >-
                  Stable machine-readable error code — branch on this, not
                  `title`.
                enum:
                  - rate_limited
              detail:
                type: string
                description: Human explanation of this occurrence.
              request_id:
                type: string
                description: Correlation id, also sent as x-request-id.
              retry_after:
                type: integer
                description: >-
                  Seconds until the window resets — the same value as the
                  `Retry-After` header.
          example:
            type: https://docs.iotools.cloud/errors/rate_limited
            title: Rate limit exceeded
            status: 429
            code: rate_limited
            detail: Too many requests. Retry in 30s.
            request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
            retry_after: 30
    ToolFailed:
      description: Tool failed to run.
      content:
        application/problem+json:
          schema:
            type: object
            description: >-
              RFC 9457 problem document, served as application/problem+json.
              Branch on `code`; `title` is human prose and may be reworded
              without notice. Some failures add extension members — `fields` on
              validation errors, `retry_after` on 429s,
              `credits_used`/`credits_remaining` on billing-adjacent failures —
              documented on the responses that carry them.
            required:
              - type
              - title
              - status
              - code
            properties:
              type:
                type: string
                format: uri
                description: Stable documentation URI for this failure.
                examples:
                  - https://docs.iotools.cloud/errors/processing_error
                  - https://docs.iotools.cloud/errors/internal_error
              title:
                type: string
                description: Short human-readable summary of the failure.
                examples:
                  - Tool failed to run
                  - Internal error
              status:
                type: integer
                description: HTTP status code, matching the response's own status.
              code:
                type: string
                description: >-
                  Stable machine-readable error code — branch on this, not
                  `title`.
                enum:
                  - processing_error
                  - internal_error
              detail:
                type: string
                description: Human explanation of this occurrence.
              request_id:
                type: string
                description: Correlation id, also sent as x-request-id.
              credits_used:
                type: integer
                description: >-
                  Always 0 on `processing_error` — a failed run is refunded,
                  floor included.
              credits_remaining:
                type: integer
                description: >-
                  Credits left after the refund. Absent when metering is
                  disabled.
          example:
            type: https://docs.iotools.cloud/errors/processing_error
            title: Tool failed to run
            status: 500
            code: processing_error
            detail: The tool failed to run. Please try again.
            request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
            credits_used: 0
    ToolDisabled:
      description: Tool temporarily disabled.
      content:
        application/problem+json:
          schema:
            type: object
            description: >-
              RFC 9457 problem document, served as application/problem+json.
              Branch on `code`; `title` is human prose and may be reworded
              without notice. Some failures add extension members — `fields` on
              validation errors, `retry_after` on 429s,
              `credits_used`/`credits_remaining` on billing-adjacent failures —
              documented on the responses that carry them.
            required:
              - type
              - title
              - status
              - code
            properties:
              type:
                type: string
                format: uri
                description: Stable documentation URI for this failure.
                examples:
                  - https://docs.iotools.cloud/errors/tool_disabled
                  - https://docs.iotools.cloud/errors/api_unconfigured
              title:
                type: string
                description: Short human-readable summary of the failure.
                examples:
                  - Tool temporarily disabled
                  - API not configured
              status:
                type: integer
                description: HTTP status code, matching the response's own status.
              code:
                type: string
                description: >-
                  Stable machine-readable error code — branch on this, not
                  `title`.
                enum:
                  - tool_disabled
                  - api_unconfigured
              detail:
                type: string
                description: Human explanation of this occurrence.
              request_id:
                type: string
                description: Correlation id, also sent as x-request-id.
          example:
            type: https://docs.iotools.cloud/errors/tool_disabled
            title: Tool temporarily disabled
            status: 503
            code: tool_disabled
            detail: This tool is temporarily unavailable. Try again shortly.
            request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: iot_live_…

````

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