> ## 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.
# README Badge Generator
> Generate shields.io-style SVG badges for GitHub READMEs — pick a preset (version, license, build, coverage...) or fully customize the label, message, colors and style, and get SVG, Markdown, HTML and a data-URL to copy.
[Try README Badge Generator in your browser →](https://iotools.cloud/tool/readme-badge-generator/)
## OpenAPI
````yaml https://api.iotools.cloud/v1/openapi post /v1/tool/readme-badge-generator
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/readme-badge-generator:
post:
tags:
- Generators
summary: README Badge Generator
description: >-
Generate shields.io-style SVG badges for GitHub READMEs — pick a preset
(version, license, build, coverage...) or fully customize the label,
message, colors and style, and get SVG, Markdown, HTML and a data-URL to
copy.
[Try README Badge Generator in your browser
→](https://iotools.cloud/tool/readme-badge-generator/)
operationId: run_readme_badge_generator
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
badgeTemplate:
enum:
- custom
- version
- license
- build
- coverage
- downloads
- stars
- love
description: Preset
badgeLabel:
type: string
description: Label
badgeMessage:
type: string
description: Message
labelColor:
type: string
description: Label Color
messageColorPreset:
enum:
- '#4c1'
- '#97ca00'
- '#a4a61d'
- '#dfb317'
- '#fe7d37'
- '#e05d44'
- '#007ec6'
- '#9f9f9f'
- '#464aff'
- custom
description: Message Color
messageColor:
type: string
description: Custom Color
badgeStyle:
enum:
- flat
- flat-square
- for-the-badge
- plastic
description: Style
required: []
examples:
build_passing_flat:
summary: Build passing (flat)
value:
badgeTemplate: custom
badgeLabel: build
badgeMessage: passing
labelColor: '#555555'
messageColorPreset: '#4c1'
messageColor: '#4c1'
badgeStyle: flat
license_mit_for_the_badge:
summary: License MIT (for-the-badge)
value:
badgeTemplate: custom
badgeLabel: license
badgeMessage: MIT
labelColor: '#555555'
messageColorPreset: '#97ca00'
messageColor: '#4c1'
badgeStyle: for-the-badge
responses:
'200':
description: Tool output
content:
application/json:
examples:
build_passing_flat:
summary: Build passing (flat)
value:
tool: readme-badge-generator
tool_version: 1.0.1
outputs:
badgeUrl: >-
data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%2288%22%20height%3D%2220%22%20role%3D%22img%22%20aria-label%3D%22build%3A%20passing%22%3E%3Ctitle%3Ebuild%3A%20passing%3C%2Ftitle%3E%3Cfilter%20id%3D%22blur%22%3E%3CfeGaussianBlur%20stdDeviation%3D%2216%22%2F%3E%3C%2Ffilter%3E%3ClinearGradient%20id%3D%22s%22%20x2%3D%220%22%20y2%3D%22100%25%22%3E%3Cstop%20offset%3D%220%22%20stop-color%3D%22%23bbb%22%20stop-opacity%3D%22.1%22%2F%3E%3Cstop%20offset%3D%221%22%20stop-opacity%3D%22.1%22%2F%3E%3C%2FlinearGradient%3E%3CclipPath%20id%3D%22r%22%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20rx%3D%223%22%2F%3E%3C%2FclipPath%3E%3Cg%20clip-path%3D%22url(%23r)%22%3E%3Crect%20width%3D%2237%22%20height%3D%2220%22%20fill%3D%22%23555555%22%2F%3E%3Crect%20x%3D%2237%22%20width%3D%2251%22%20height%3D%2220%22%20fill%3D%22%234c1%22%2F%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20fill%3D%22url(%23s)%22%2F%3E%3C%2Fg%3E%3Cg%20fill%3D%22%23fff%22%20text-anchor%3D%22middle%22%20font-family%3D%22Verdana%2CGeneva%2CDejaVu%20Sans%2Csans-serif%22%20text-rendering%3D%22geometricPrecision%22%20font-size%3D%22110%22%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22195%22%20y%3D%22140%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22615%22%20y%3D%22140%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fg%3E%3C%2Fsvg%3E
badgeMarkdown: >-
%22%3E%3Crect%20width%3D%2237%22%20height%3D%2220%22%20fill%3D%22%23555555%22%2F%3E%3Crect%20x%3D%2237%22%20width%3D%2251%22%20height%3D%2220%22%20fill%3D%22%234c1%22%2F%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20fill%3D%22url(%23s)%22%2F%3E%3C%2Fg%3E%3Cg%20fill%3D%22%23fff%22%20text-anchor%3D%22middle%22%20font-family%3D%22Verdana%2CGeneva%2CDejaVu%20Sans%2Csans-serif%22%20text-rendering%3D%22geometricPrecision%22%20font-size%3D%22110%22%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22195%22%20y%3D%22140%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22615%22%20y%3D%22140%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fg%3E%3C%2Fsvg%3E)
badgeHtml: >-
badgeSvg: >-
credits_used: 3
credits_remaining: null
license_mit_for_the_badge:
summary: License MIT (for-the-badge)
value:
tool: readme-badge-generator
tool_version: 1.0.1
outputs:
badgeUrl: >-
data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%22124.5%22%20height%3D%2228%22%20role%3D%22img%22%20aria-label%3D%22LICENSE%3A%20MIT%22%3E%3Ctitle%3ELICENSE%3A%20MIT%3C%2Ftitle%3E%3Cg%20shape-rendering%3D%22crispEdges%22%3E%3Crect%20width%3D%2275.75%22%20height%3D%2228%22%20fill%3D%22%23555555%22%2F%3E%3Crect%20x%3D%2275.75%22%20width%3D%2248.75%22%20height%3D%2228%22%20fill%3D%22%2397ca00%22%2F%3E%3C%2Fg%3E%3Cg%20fill%3D%22%23fff%22%20text-anchor%3D%22middle%22%20font-family%3D%22Verdana%2CGeneva%2CDejaVu%20Sans%2Csans-serif%22%20text-rendering%3D%22geometricPrecision%22%20font-size%3D%22100%22%3E%3Ctext%20transform%3D%22scale(.1)%22%20x%3D%22378.75%22%20y%3D%22175%22%20textLength%3D%22517.5%22%3ELICENSE%3C%2Ftext%3E%3Ctext%20transform%3D%22scale(.1)%22%20x%3D%221001.25%22%20y%3D%22175%22%20textLength%3D%22247.5%22%20font-weight%3D%22bold%22%3EMIT%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fsvg%3E
badgeMarkdown: >-
%22%20x%3D%22378.75%22%20y%3D%22175%22%20textLength%3D%22517.5%22%3ELICENSE%3C%2Ftext%3E%3Ctext%20transform%3D%22scale(.1)%22%20x%3D%221001.25%22%20y%3D%22175%22%20textLength%3D%22247.5%22%20font-weight%3D%22bold%22%3EMIT%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fsvg%3E)
badgeHtml: >-
badgeSvg: >-
credits_used: 3
credits_remaining: null
schema:
type: object
required:
- tool
- tool_version
- outputs
- credits_used
- credits_remaining
properties:
outputs:
type: object
properties:
badgeUrl:
type: string
description: Data URL
badgeMarkdown:
type: string
description: Markdown
badgeHtml:
type: string
description: HTML
badgeSvg:
type: string
description: SVG Source
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'
'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://iotools.cloud/docs/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://iotools.cloud/docs/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://iotools.cloud/docs/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://iotools.cloud/docs/errors/invalid_api_key
title: Invalid API key
status: 401
code: invalid_api_key
detail: 'Provide ''Authorization: Bearer ''.'
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://iotools.cloud/docs/errors/insufficient_credits
title:
type: string
description: Short human-readable summary of the failure.
examples:
- Insufficient credits
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
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://iotools.cloud/docs/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://iotools.cloud/docs/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://iotools.cloud/docs/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://iotools.cloud/docs/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://iotools.cloud/docs/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://iotools.cloud/docs/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://iotools.cloud/docs/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
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://iotools.cloud/docs/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://iotools.cloud/docs/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://iotools.cloud/docs/errors/processing_error
- https://iotools.cloud/docs/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://iotools.cloud/docs/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://iotools.cloud/docs/errors/tool_disabled
- https://iotools.cloud/docs/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://iotools.cloud/docs/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_…
````
%22%3E%3Crect%20width%3D%2237%22%20height%3D%2220%22%20fill%3D%22%23555555%22%2F%3E%3Crect%20x%3D%2237%22%20width%3D%2251%22%20height%3D%2220%22%20fill%3D%22%234c1%22%2F%3E%3Crect%20width%3D%2288%22%20height%3D%2220%22%20fill%3D%22url(%23s)%22%2F%3E%3C%2Fg%3E%3Cg%20fill%3D%22%23fff%22%20text-anchor%3D%22middle%22%20font-family%3D%22Verdana%2CGeneva%2CDejaVu%20Sans%2Csans-serif%22%20text-rendering%3D%22geometricPrecision%22%20font-size%3D%22110%22%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3Ctext%20x%3D%22195%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22195%22%20y%3D%22140%22%20textLength%3D%22270%22%3Ebuild%3C%2Ftext%3E%3C%2Fg%3E%3Cg%20transform%3D%22scale(.1)%22%3E%3Cg%20aria-hidden%3D%22true%22%20fill%3D%22%23010101%22%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.8%22%20filter%3D%22url(%23blur)%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3Ctext%20x%3D%22615%22%20y%3D%22150%22%20fill-opacity%3D%22.3%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3Ctext%20x%3D%22615%22%20y%3D%22140%22%20textLength%3D%22410%22%3Epassing%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fg%3E%3C%2Fsvg%3E)
badgeSvg: >-
credits_used: 3
credits_remaining: null
license_mit_for_the_badge:
summary: License MIT (for-the-badge)
value:
tool: readme-badge-generator
tool_version: 1.0.1
outputs:
badgeUrl: >-
data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%22124.5%22%20height%3D%2228%22%20role%3D%22img%22%20aria-label%3D%22LICENSE%3A%20MIT%22%3E%3Ctitle%3ELICENSE%3A%20MIT%3C%2Ftitle%3E%3Cg%20shape-rendering%3D%22crispEdges%22%3E%3Crect%20width%3D%2275.75%22%20height%3D%2228%22%20fill%3D%22%23555555%22%2F%3E%3Crect%20x%3D%2275.75%22%20width%3D%2248.75%22%20height%3D%2228%22%20fill%3D%22%2397ca00%22%2F%3E%3C%2Fg%3E%3Cg%20fill%3D%22%23fff%22%20text-anchor%3D%22middle%22%20font-family%3D%22Verdana%2CGeneva%2CDejaVu%20Sans%2Csans-serif%22%20text-rendering%3D%22geometricPrecision%22%20font-size%3D%22100%22%3E%3Ctext%20transform%3D%22scale(.1)%22%20x%3D%22378.75%22%20y%3D%22175%22%20textLength%3D%22517.5%22%3ELICENSE%3C%2Ftext%3E%3Ctext%20transform%3D%22scale(.1)%22%20x%3D%221001.25%22%20y%3D%22175%22%20textLength%3D%22247.5%22%20font-weight%3D%22bold%22%3EMIT%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fsvg%3E
badgeMarkdown: >-
%22%20x%3D%22378.75%22%20y%3D%22175%22%20textLength%3D%22517.5%22%3ELICENSE%3C%2Ftext%3E%3Ctext%20transform%3D%22scale(.1)%22%20x%3D%221001.25%22%20y%3D%22175%22%20textLength%3D%22247.5%22%20font-weight%3D%22bold%22%3EMIT%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fsvg%3E)
badgeHtml: >-
%22%20x%3D%22378.75%22%20y%3D%22175%22%20textLength%3D%22517.5%22%3ELICENSE%3C%2Ftext%3E%3Ctext%20transform%3D%22scale(.1)%22%20x%3D%221001.25%22%20y%3D%22175%22%20textLength%3D%22247.5%22%20font-weight%3D%22bold%22%3EMIT%3C%2Ftext%3E%3C%2Fg%3E%3C%2Fsvg%3E)
badgeSvg: >-
credits_used: 3
credits_remaining: null
schema:
type: object
required:
- tool
- tool_version
- outputs
- credits_used
- credits_remaining
properties:
outputs:
type: object
properties:
badgeUrl:
type: string
description: Data URL
badgeMarkdown:
type: string
description: Markdown
badgeHtml:
type: string
description: HTML
badgeSvg:
type: string
description: SVG Source
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'
'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://iotools.cloud/docs/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://iotools.cloud/docs/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://iotools.cloud/docs/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://iotools.cloud/docs/errors/invalid_api_key
title: Invalid API key
status: 401
code: invalid_api_key
detail: 'Provide ''Authorization: Bearer