BriskTool API Documentation

Integrate text processing, developer tools, calculators, unit conversion, and QR code generation into your apps with a simple REST API.

Authentication

All API requests require a Bearer token in the Authorization header. API keys are available on Pro and Business plans.

Authorization: Bearer YOUR_API_KEY

Get your API key: Sign in at brisktool.com/account and navigate to the API Keys section.

Base URL: https://api.brisktool.com

Rate Limits

Plan	Monthly Calls	Max Payload
Pro ($12/mo)	200 calls	100 KB
Business ($24/mo)	1,000 calls	100 KB
Enterprise	Custom	Custom

Limits reset on the 1st of each month. Exceeding your limit returns 429 Too Many Requests. Contact us for higher limits.

Endpoints

Jump to endpoint

/v1/text/case-convert /v1/text/word-count /v1/text/slug /v1/dev/json-format /v1/dev/base64 /v1/dev/hash /v1/dev/uuid /v1/dev/url-encode /v1/calc/percentage /v1/convert/units /v1/qr/generate

POST/v1/text/case-convert

Convert text between upper, lower, title, sentence, camel, snake, and kebab case.

Parameters

Name	Type	Required	Description
text	string	Yes	The text to convert
to	string	No	Target case: upper, lower, title, sentence, camel, snake, kebab (default: lower)

Example Request (cURL)

curl -X POST https://api.brisktool.com/v1/text/case-convert \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "hello world example", "to": "title" }'

Response

{
  "result": "Hello World Example",
  "from": 19,
  "to": "title"
}

POST/v1/text/word-count

Count words, characters, sentences, paragraphs, and estimate reading time.

Parameters

Name	Type	Required	Description
text	string	Yes	The text to analyze

Example Request (cURL)

curl -X POST https://api.brisktool.com/v1/text/word-count \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Hello world. This is a test." }'

Response

{
  "words": 6,
  "characters": 28,
  "characters_no_spaces": 23,
  "sentences": 2,
  "paragraphs": 1,
  "reading_time_minutes": 1
}

POST/v1/text/slug

Generate URL-friendly slugs from any text. Handles Unicode and special characters.

Parameters

Name	Type	Required	Description
text	string	Yes	Text to convert to a slug

Example Request (cURL)

curl -X POST https://api.brisktool.com/v1/text/slug \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Hello World! This is a Test" }'

Response

{
  "slug": "hello-world-this-is-a-test"
}

POST/v1/dev/json-format

Format and validate JSON strings with configurable indentation.

Parameters

Name	Type	Required	Description
json	string	Yes	JSON string to format
indent	number	No	Indentation spaces (default: 2)

Example Request (cURL)

curl -X POST https://api.brisktool.com/v1/dev/json-format \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "json": "{\"name\":\"test\",\"value\":123}", "indent": 2 }'

Response

{
  "formatted": "{\n  \"name\": \"test\",\n  \"value\": 123\n}",
  "valid": true
}

POST/v1/dev/base64

Encode text to Base64 or decode Base64 back to text.

Parameters

Name	Type	Required	Description
text	string	Yes	Text to encode, or Base64 string to decode
action	string	No	"encode" (default) or "decode"

Example Request (cURL)

curl -X POST https://api.brisktool.com/v1/dev/base64 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Hello World", "action": "encode" }'

Response

{
  "result": "SGVsbG8gV29ybGQ="
}

POST/v1/dev/hash

Generate MD5, SHA-1, SHA-256, or SHA-512 hashes from text.

Parameters

Name	Type	Required	Description
text	string	Yes	Text to hash
algorithm	string	No	md5, sha1, sha256 (default), sha512

Example Request (cURL)

curl -X POST https://api.brisktool.com/v1/dev/hash \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Hello World", "algorithm": "sha256" }'

Response

{
  "hash": "a591a6d40bf420...",
  "algorithm": "SHA-256"
}

POST/v1/dev/uuid

Generate one or more v4 UUIDs.

Parameters

Name	Type	Required	Description
count	number	No	Number of UUIDs to generate (default: 1, max: 100)

Example Request (cURL)

curl -X POST https://api.brisktool.com/v1/dev/uuid \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "count": 3 }'

Response

{
  "uuids": [
    "550e8400-e29b-41d4-...",
    "6ba7b810-9dad-11d1-...",
    "f47ac10b-58cc-4372-..."
  ]
}

POST/v1/dev/url-encode

Encode or decode URL components.

Parameters

Name	Type	Required	Description
text	string	Yes	Text to encode/decode
action	string	No	"encode" (default) or "decode"

Example Request (cURL)

curl -X POST https://api.brisktool.com/v1/dev/url-encode \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "hello world & foo=bar", "action": "encode" }'

Response

{
  "result": "hello%20world%20%26%20foo%3Dbar"
}

POST/v1/calc/percentage

Calculate percentages with three modes: "of" (X% of Y), "is" (X is what % of Y), "change" (% change from X to Y).

Parameters

Name	Type	Required	Description
mode	string	Yes	"of", "is", or "change"
a	number	Yes	First number
b	number	Yes	Second number

Example Request (cURL)

curl -X POST https://api.brisktool.com/v1/calc/percentage \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "mode": "of", "a": 15, "b": 200 }'

Response

{
  "result": 30,
  "description": "15% of 200"
}

POST/v1/convert/units

Convert between units of length, weight, temperature, volume, area, speed, and data.

Parameters

Name	Type	Required	Description
value	number	Yes	The value to convert
from	string	Yes	Source unit (e.g. mi, kg, c, l)
to	string	Yes	Target unit
category	string	No	length, weight, temperature, volume, area, speed, data (auto-detected if omitted)

Example Request (cURL)

curl -X POST https://api.brisktool.com/v1/convert/units \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "value": 5, "from": "mi", "to": "km", "category": "length" }'

Response

{
  "result": 8.0467,
  "from": "mi",
  "to": "km",
  "value": 5,
  "category": "length"
}

POST/v1/qr/generate

Generate a QR code as a Base64-encoded PNG image.

Parameters

Name	Type	Required	Description
data	string	Yes	Text or URL to encode in the QR code
size	number	No	Image size in pixels (default: 256, max: 1024)

Example Request (cURL)

curl -X POST https://api.brisktool.com/v1/qr/generate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "data": "https://brisktool.com", "size": 256 }'

Response

{
  "image": "data:image/png;base64,iVBOR...",
  "size": 256,
  "data": "https://brisktool.com"
}

Code Examples

JavaScript (fetch)

const response = await fetch("https://api.brisktool.com/v1/text/case-convert", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ text: "hello world", to: "title" }),
});

const data = await response.json();
console.log(data.result); // "Hello World"

Python (requests)

import requests

response = requests.post(
    "https://api.brisktool.com/v1/text/case-convert",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"text": "hello world", "to": "title"},
)

data = response.json()
print(data["result"])  # "Hello World"

Apple Shortcuts (via URL action)

Use the "Get Contents of URL" action in Apple Shortcuts to call any BriskTool API endpoint. See our pre-built shortcuts for ready-to-use examples.

Error Codes

Code	Meaning
400	Bad Request — missing or invalid parameters
401	Unauthorized — missing or malformed API key
403	Forbidden — invalid or inactive API key
429	Too Many Requests — monthly rate limit exceeded
500	Internal Server Error — something went wrong on our end
503	Service Unavailable — API temporarily unavailable

Start building with the BriskTool API

Get an API key in minutes. 11 endpoints ready to use today.

Get API Access →Apple Shortcuts