{ "openapi": "3.1.0", "info": { "title": "Base64.sh Utility API", "version": "1.0.0", "description": "Anonymous text utility APIs. Approximately 60 POST requests/minute per IP per Cloudflare location; 32 KiB JSON request limit. Request bodies are processed server-side in memory. See /api/ for contracts and data handling." }, "servers": [ { "url": "https://www.base64.sh" } ], "paths": { "/api/v1/base64/": { "post": { "operationId": "base64", "tags": [ "Encoding" ], "summary": "Base64 API", "description": "Encode UTF-8 text as Base64 or decode it through a JSON HTTP API, with standard and URL-safe alphabets.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/base64/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "Plain text to encode, or Base64 text to decode." }, "operation": { "type": "string", "enum": [ "encode", "decode" ], "default": "encode", "description": "Encode UTF-8 text or decode an encoded UTF-8 string." }, "urlSafe": { "type": "boolean", "default": false, "description": "Use the RFC 4648 URL-safe alphabet (- and _)." }, "padding": { "type": "boolean", "default": true, "description": "Include trailing = characters when encoding." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Encode Unicode", "value": { "text": "Hello 世界" } }, "example2": { "summary": "Decode", "value": { "text": "SGVsbG8=", "operation": "decode" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." } }, "required": [ "result" ] } } }, "example": { "ok": true, "data": { "result": "SGVsbG8g5LiW55WM" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/base32/": { "post": { "operationId": "base32", "tags": [ "Encoding" ], "summary": "Base32 API", "description": "Convert UTF-8 text to RFC 4648 Base32 and decode valid Base32 text with a scriptable HTTP endpoint.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/base32/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "Plain text or RFC 4648 Base32." }, "operation": { "type": "string", "enum": [ "encode", "decode" ], "default": "encode", "description": "Encode UTF-8 text or decode an encoded UTF-8 string." }, "padding": { "type": "boolean", "default": true, "description": "Include = padding when encoding." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Encode", "value": { "text": "foo" } }, "example2": { "summary": "Decode", "value": { "text": "MZXW6===", "operation": "decode" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." } }, "required": [ "result" ] } } }, "example": { "ok": true, "data": { "result": "MZXW6===" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/base58/": { "post": { "operationId": "base58", "tags": [ "Encoding" ], "summary": "Base58 API", "description": "Encode and decode short UTF-8 strings using the Bitcoin Base58 alphabet, preserving leading zero bytes.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/base58/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 1024, "description": "Text to encode (at most 512 UTF-8 bytes), or Base58 to decode (at most 1024 characters)." }, "operation": { "type": "string", "enum": [ "encode", "decode" ], "default": "encode", "description": "Encode UTF-8 text or decode an encoded UTF-8 string." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Encode", "value": { "text": "Hello World" } }, "example2": { "summary": "Decode", "value": { "text": "JxF12TrwUP45BMd", "operation": "decode" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." } }, "required": [ "result" ] } } }, "example": { "ok": true, "data": { "result": "JxF12TrwUP45BMd" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/url-encoder/": { "post": { "operationId": "urlEncoder", "tags": [ "Encoding" ], "summary": "URL Encoding API", "description": "Percent-encode or decode a URL component, full URI or form value with explicit encoding modes.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/url-encoder/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "The component, URI or form value." }, "operation": { "type": "string", "enum": [ "encode", "decode" ], "default": "encode", "description": "Encode UTF-8 text or decode an encoded UTF-8 string." }, "mode": { "type": "string", "enum": [ "component", "uri", "form" ], "default": "component", "description": "component uses encodeURIComponent; uri uses encodeURI; form uses application/x-www-form-urlencoded value rules." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Query component", "value": { "text": "coffee & tea / café" } }, "example2": { "summary": "Form value", "value": { "text": "coffee+%26+tea", "operation": "decode", "mode": "form" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." } }, "required": [ "result" ] } } }, "example": { "ok": true, "data": { "result": "coffee%20%26%20tea%20%2F%20caf%C3%A9" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/hex-to-text/": { "post": { "operationId": "hexToText", "tags": [ "Encoding" ], "summary": "Hex to Text API", "description": "Decode hexadecimal UTF-8 bytes into text or encode text as hexadecimal, with strict byte validation.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/hex-to-text/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "Text to encode, or pairs of hexadecimal digits separated by optional whitespace." }, "operation": { "type": "string", "enum": [ "encode", "decode" ], "default": "decode", "description": "decode reads hexadecimal bytes; encode converts UTF-8 text to lowercase hex." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Decode bytes", "value": { "text": "48 65 6c 6c 6f" } }, "example2": { "summary": "Encode Unicode", "value": { "text": "你好", "operation": "encode" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." } }, "required": [ "result" ] } } }, "example": { "ok": true, "data": { "result": "Hello" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/binary/": { "post": { "operationId": "binary", "tags": [ "Encoding" ], "summary": "Text to Binary API", "description": "Convert UTF-8 text into eight-bit binary bytes, or decode a binary byte string into text.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/binary/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "Text or eight-bit binary bytes." }, "operation": { "type": "string", "enum": [ "encode", "decode" ], "default": "encode", "description": "Encode UTF-8 text or decode an encoded UTF-8 string." }, "spaces": { "type": "boolean", "default": true, "description": "Separate encoded bytes with a space." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Encode", "value": { "text": "Hi" } }, "example2": { "summary": "Decode", "value": { "text": "01001000 01101001", "operation": "decode" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." } }, "required": [ "result" ] } } }, "example": { "ok": true, "data": { "result": "01001000 01101001" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/html-entity/": { "post": { "operationId": "htmlEntity", "tags": [ "Encoding" ], "summary": "HTML Entity API", "description": "Encode plain text as HTML entities or decode named and numeric HTML character references through an API.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/html-entity/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "Plain text or HTML character references." }, "operation": { "type": "string", "enum": [ "encode", "decode" ], "default": "encode", "description": "Encode UTF-8 text or decode an encoded UTF-8 string." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Encode markup characters", "value": { "text": "

A & B

" } }, "example2": { "summary": "Decode references", "value": { "text": "© & 😀", "operation": "decode" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." } }, "required": [ "result" ] } } }, "example": { "ok": true, "data": { "result": "<p title="café">A & B</p>" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/json-formatter/": { "post": { "operationId": "jsonFormatter", "tags": [ "Data" ], "summary": "JSON Formatter API", "description": "Format, minify or validate JSON without rounding large numbers or losing duplicate and prototype-like keys.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/json-formatter/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "The JSON document as a string. Use a string so the caller’s JSON serializer cannot round its numbers." }, "operation": { "type": "string", "enum": [ "format", "minify", "validate" ], "default": "format", "description": "Select pretty printing, whitespace removal or syntax validation." }, "indent": { "type": "integer", "minimum": 0, "maximum": 8, "default": 2, "description": "Spaces per indentation level for format." }, "sortKeys": { "type": "boolean", "default": false, "description": "Sort object keys lexically when formatting; duplicate-key order is stable." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Preserve large numbers", "value": { "text": "{\"id\":9007199254740993,\"amount\":2.370}" } }, "example2": { "summary": "Minify", "value": { "text": "{\n \"ok\": true, \"items\": [1, 2]\n}", "operation": "minify" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." }, "stats": { "type": "object", "properties": { "keys": { "type": "integer" }, "maxDepth": { "type": "integer" } }, "required": [ "keys", "maxDepth" ], "additionalProperties": false } }, "required": [ "result", "stats" ] } } }, "example": { "ok": true, "data": { "result": "{\n \"id\": 9007199254740993,\n \"amount\": 2.370\n}", "stats": { "keys": 2, "maxDepth": 1 } } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/sha1-hash/": { "post": { "operationId": "sha1Hash", "tags": [ "Checksums" ], "summary": "SHA-1 API", "description": "Calculate a SHA-1 digest of UTF-8 text and receive its lowercase hexadecimal representation in JSON.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/sha1-hash/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "Text hashed exactly as supplied. Spaces, line endings and a trailing newline change the digest." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Known text", "value": { "text": "abc" } }, "example2": { "summary": "Empty string", "value": { "text": "" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "algorithm": { "type": "string", "enum": [ "SHA-1" ] }, "hex": { "type": "string", "pattern": "^[0-9a-f]{40}$", "description": "40 lowercase hex digits." } }, "required": [ "algorithm", "hex" ] } } }, "example": { "ok": true, "data": { "algorithm": "SHA-1", "hex": "a9993e364706816aba3e25717850c26c9cd0d89d" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/sha256-hash/": { "post": { "operationId": "sha256Hash", "tags": [ "Checksums" ], "summary": "SHA-256 API", "description": "Calculate a SHA-256 digest of UTF-8 text and receive its lowercase hexadecimal representation in JSON.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/sha256-hash/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "Text hashed exactly as supplied. Spaces, line endings and a trailing newline change the digest." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Known text", "value": { "text": "abc" } }, "example2": { "summary": "Empty string", "value": { "text": "" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "algorithm": { "type": "string", "enum": [ "SHA-256" ] }, "hex": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "64 lowercase hex digits." } }, "required": [ "algorithm", "hex" ] } } }, "example": { "ok": true, "data": { "algorithm": "SHA-256", "hex": "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/sha512-hash/": { "post": { "operationId": "sha512Hash", "tags": [ "Checksums" ], "summary": "SHA-512 API", "description": "Calculate a SHA-512 digest of UTF-8 text and receive its lowercase hexadecimal representation in JSON.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/sha512-hash/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "Text hashed exactly as supplied. Spaces, line endings and a trailing newline change the digest." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Known text", "value": { "text": "abc" } }, "example2": { "summary": "Empty string", "value": { "text": "" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "algorithm": { "type": "string", "enum": [ "SHA-512" ] }, "hex": { "type": "string", "pattern": "^[0-9a-f]{128}$", "description": "128 lowercase hex digits." } }, "required": [ "algorithm", "hex" ] } } }, "example": { "ok": true, "data": { "algorithm": "SHA-512", "hex": "ddaf35a193617abacc417349ae20413112e6fa4e89a97ea20a9eeee64b55d39a2192992a274fc1a836ba3c23a3feebbd454d4423643ce80e2a9ac94fa54ca49f" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/crc32-checksum/": { "post": { "operationId": "crc32Checksum", "tags": [ "Checksums" ], "summary": "CRC32 API", "description": "Calculate the standard IEEE CRC-32 checksum of UTF-8 text, returning hexadecimal and unsigned decimal values.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/crc32-checksum/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "Text to checksum as UTF-8 bytes, without trimming or newline conversion." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Standard check value", "value": { "text": "123456789" } }, "example2": { "summary": "Empty input", "value": { "text": "" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "hex": { "type": "string", "pattern": "^[0-9a-f]{8}$" }, "decimal": { "type": "integer", "minimum": 0, "maximum": 4294967295 } }, "required": [ "hex", "decimal" ] } } }, "example": { "ok": true, "data": { "hex": "cbf43926", "decimal": 3421780262 } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/word-counter/": { "post": { "operationId": "wordCounter", "tags": [ "Text" ], "summary": "Word Counter API", "description": "Count words, Unicode characters, sentences, paragraphs and UTF-8 bytes, with configurable reading and speaking time estimates.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/word-counter/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "Text to analyze. Whitespace and line breaks are included in character counts." }, "readingWpm": { "type": "integer", "minimum": 1, "maximum": 2000, "default": 238, "description": "Reading speed in words per minute." }, "speakingWpm": { "type": "integer", "minimum": 1, "maximum": 2000, "default": 150, "description": "Speaking speed in words per minute." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Article excerpt", "value": { "text": "Hello world.\n\nSecond paragraph." } }, "example2": { "summary": "Mixed scripts", "value": { "text": "Hello 世界 😀" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "words": { "type": "integer", "minimum": 0, "description": "Number of words." }, "chars": { "type": "integer", "minimum": 0, "description": "Unicode code points, including whitespace." }, "charsNoSpace": { "type": "integer", "minimum": 0, "description": "Code points after removing whitespace." }, "sentences": { "type": "integer", "minimum": 0, "description": "Number of sentences." }, "paragraphs": { "type": "integer", "minimum": 0, "description": "Number of paragraphs." }, "lines": { "type": "integer", "minimum": 0, "description": "Number of lines." }, "bytes": { "type": "integer", "minimum": 0, "description": "UTF-8 bytes." }, "unique": { "type": "integer", "minimum": 0, "description": "Case-insensitive unique word tokens." }, "readingSeconds": { "type": "integer", "minimum": 0, "description": "Rounded reading duration in seconds." }, "speakingSeconds": { "type": "integer", "minimum": 0, "description": "Rounded speaking duration in seconds." } }, "required": [ "words", "chars", "charsNoSpace", "sentences", "paragraphs", "lines", "bytes", "unique", "readingSeconds", "speakingSeconds" ] } } }, "example": { "ok": true, "data": { "words": 4, "chars": 31, "charsNoSpace": 27, "sentences": 2, "paragraphs": 2, "lines": 3, "bytes": 31, "unique": 4, "readingSeconds": 1, "speakingSeconds": 2 } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/slug-generator/": { "post": { "operationId": "slugGenerator", "tags": [ "Text" ], "summary": "Slug Generator API", "description": "Generate URL slugs with accent transliteration, configurable separators, word-boundary length limits and optional stop-word removal.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/slug-generator/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "A title or short phrase." }, "separator": { "type": "string", "enum": [ "-", "_", "." ], "default": "-", "description": "Character used between words." }, "lowercase": { "type": "boolean", "default": true, "description": "Lowercase the result." }, "maxLength": { "type": "integer", "minimum": 0, "maximum": 1000, "default": 0, "description": "Maximum slug length; zero means no extra limit. Complete words are retained where possible." }, "stopWords": { "type": "boolean", "default": false, "description": "Remove common English stop words." }, "transliterate": { "type": "boolean", "default": true, "description": "Transliterate supported Latin accents, Cyrillic and Greek." }, "german": { "type": "boolean", "default": false, "description": "Expand German umlauts, for example ä to ae." }, "keepUnicode": { "type": "boolean", "default": false, "description": "Keep non-Latin letters and numbers." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Transliterate accents", "value": { "text": "Crème brûlée: 10 Tips & Tricks!" } }, "example2": { "summary": "Keep Chinese", "value": { "text": "你好 世界", "keepUnicode": true } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." } }, "required": [ "result" ] } } }, "example": { "ok": true, "data": { "result": "creme-brulee-10-tips-tricks" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/text-line-tools/": { "post": { "operationId": "textLineTools", "tags": [ "Text" ], "summary": "Text Line Tools API", "description": "Sort, deduplicate, reverse, trim, number or wrap text lines through a single JSON endpoint.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/text-line-tools/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "A line-separated list, at most 1000 lines." }, "operation": { "type": "string", "enum": [ "sort", "dedupe", "reverse", "empty", "trim", "number", "affix" ], "default": "sort", "description": "One line operation per request; shuffle is not included in this API." }, "sortMode": { "type": "string", "enum": [ "alpha", "natural", "length", "numeric" ], "default": "alpha", "description": "Sort by code point, natural order, code-point length or leading number." }, "desc": { "type": "boolean", "default": false, "description": "Reverse the sort comparison." }, "ignoreCase": { "type": "boolean", "default": false, "description": "Ignore case for sorting and duplicate comparison." }, "ddMode": { "type": "string", "enum": [ "unique", "duplicates", "singletons" ], "default": "unique", "description": "Keep first occurrences, repeated values only or non-repeated values only." }, "trimCompare": { "type": "boolean", "default": false, "description": "Trim values only for duplicate comparison." }, "trimMode": { "type": "string", "enum": [ "both", "start", "end" ], "default": "both", "description": "Which side of a line to trim." }, "start": { "type": "integer", "minimum": -1000000, "maximum": 1000000, "default": 1, "description": "First number for number operation." }, "sep": { "type": "string", "maxLength": 20, "description": "Separator after the line number.", "default": ". " }, "pad": { "type": "boolean", "default": false, "description": "Pad line numbers to a consistent width." }, "prefix": { "type": "string", "maxLength": 100, "description": "Prefix for affix operation.", "default": "" }, "suffix": { "type": "string", "maxLength": 100, "description": "Suffix for affix operation.", "default": "" }, "skipBlank": { "type": "boolean", "default": false, "description": "Leave blank lines unchanged when adding affixes." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Natural sort", "value": { "text": "file10\nfile2\nfile1", "sortMode": "natural" } }, "example2": { "summary": "Remove duplicates", "value": { "text": "Apple\napple\nPear", "operation": "dedupe", "ignoreCase": true } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." }, "inCount": { "type": "integer", "minimum": 0 }, "outCount": { "type": "integer", "minimum": 0 } }, "required": [ "result", "inCount", "outCount" ] } } }, "example": { "ok": true, "data": { "result": "file1\nfile2\nfile10", "inCount": 3, "outCount": 3 } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/uuid-generator/": { "post": { "operationId": "uuidGenerator", "tags": [ "Identifiers" ], "summary": "UUID v4 API", "description": "Generate one or up to 100 cryptographically random UUID version 4 identifiers per API request.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/uuid-generator/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "count": { "type": "integer", "minimum": 1, "maximum": 100, "default": 1, "description": "Number of UUID v4 values to generate." } }, "required": [] }, "examples": { "example1": { "summary": "One UUID", "value": {} }, "example2": { "summary": "Batch UUIDs", "value": { "count": 3 } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "values": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string", "format": "uuid" }, "description": "Fresh UUID version 4 strings." } }, "required": [ "values" ] } } }, "example": { "ok": true, "data": { "values": [ "123e4567-e89b-42d3-a456-426614174000" ] } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/number-to-words/": { "post": { "operationId": "numberToWords", "tags": [ "Numbers" ], "summary": "Number to Words API", "description": "Spell signed decimal numbers in English while preserving long integer strings and each fractional digit.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/number-to-words/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 160, "description": "A signed decimal string, optionally with correctly grouped commas. At most 36 integer digits and 100 fractional digits." }, "british": { "type": "boolean", "default": false, "description": "Use British-style and in number groups." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Decimal digits", "value": { "text": "1234.050" } }, "example2": { "summary": "British style", "value": { "text": "1001", "british": true } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." } }, "required": [ "result" ] } } }, "example": { "ok": true, "data": { "result": "one thousand two hundred thirty-four point zero five zero" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/rmb-uppercase/": { "post": { "operationId": "rmbUppercase", "tags": [ "Numbers" ], "summary": "RMB Uppercase API", "description": "Convert decimal amounts into Chinese uppercase RMB wording with simplified or traditional financial characters.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/rmb-uppercase/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 32, "description": "Amount as a decimal string, at most 16 integer digits and two fractional digits." }, "traditional": { "type": "boolean", "default": false, "description": "Use traditional financial characters in the result." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Yuan and fen", "value": { "text": "1001.05" } }, "example2": { "summary": "Traditional characters", "value": { "text": "1234.50", "traditional": true } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." } }, "required": [ "result" ] } } }, "example": { "ok": true, "data": { "result": "人民币壹仟零壹元零伍分" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/chinese-converter/": { "post": { "operationId": "chineseConverter", "tags": [ "Text" ], "summary": "Simplified and Traditional Chinese API", "description": "Convert Chinese text with OpenCC phrase dictionaries, including mainland, Taiwan and Hong Kong variants.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/chinese-converter/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "Chinese text to convert." }, "from": { "type": "string", "enum": [ "cn", "tw", "twp", "hk" ], "default": "cn", "description": "cn: simplified mainland; tw: traditional Taiwan; twp: Taiwan phrases; hk: traditional Hong Kong." }, "to": { "type": "string", "enum": [ "cn", "tw", "twp", "hk" ], "default": "tw", "description": "Target OpenCC locale and optional Taiwan phrase conversion." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "Simplified to traditional", "value": { "text": "汉字转换，软件开发。" } }, "example2": { "summary": "Traditional to simplified", "value": { "text": "繁體中文與軟體", "from": "tw", "to": "cn" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." } }, "required": [ "result" ] } } }, "example": { "ok": true, "data": { "result": "漢字轉換，軟件開發。" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/api/v1/rot13/": { "post": { "operationId": "rot13", "tags": [ "Encoding" ], "summary": "ROT13 and ROT47 API", "description": "Apply ROT13 to ASCII letters or ROT47 to printable ASCII characters through a reversible text API.", "security": [], "externalDocs": { "url": "https://www.base64.sh/api/rot13/" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 16384, "description": "Text to transform." }, "mode": { "type": "string", "enum": [ "rot13", "rot47" ], "default": "rot13", "description": "ROT13 rotates ASCII letters; ROT47 rotates ASCII characters from ! through ~." } }, "required": [ "text" ] }, "examples": { "example1": { "summary": "ROT13", "value": { "text": "Hello, World!" } }, "example2": { "summary": "ROT47", "value": { "text": "Hello, World!", "mode": "rot47" } } } } } }, "responses": { "200": { "description": "Successful result", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "data" ], "additionalProperties": false, "properties": { "ok": { "const": true }, "data": { "type": "object", "additionalProperties": false, "properties": { "result": { "type": "string", "description": "The converted text. Empty input can produce an empty result." } }, "required": [ "result" ] } } }, "example": { "ok": true, "data": { "result": "Uryyb, Jbeyq!" } } } } }, "400": { "description": "Invalid JSON or parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "403": { "description": "Cloudflare edge rejected the request before the API. Use an identifying User-Agent in programmatic clients; browsers supply their own. The response may be plain text or HTML.", "content": { "text/plain": { "schema": { "type": "string" }, "example": "error code: 1010" }, "text/html": { "schema": { "type": "string" } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "405": { "description": "Use POST", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "413": { "description": "Request or result too large", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "headers": { "Retry-After": { "description": "Seconds to wait before retrying.", "schema": { "type": "integer", "example": 60 } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "ok", "error" ], "properties": { "ok": { "const": false }, "error": { "type": "object", "additionalProperties": false, "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } } } }