Extract URL metadata and Open Graph tags for any web page. Returns a structured JSON document with title, description, image, site name, type, favicon, theme color, author, and published date for use in link previews and content cards.
openapi: 3.0.3
info:
title: API Snap
version: 1.0.0
description: API Snap is a developer utility API that bundles 13+ common tools into a single REST API with one API key. Generate QR codes, resize images, capture screenshots, convert HTML to PDF,
hash strings, generate UUIDs, extract URL metadata, and more. Free tier includes 100 API calls/month with no credit card required. All endpoints support CORS and return JSON (or binary where
appropriate). Built for developers who want to ship faster.
contact:
name: API Snap Support
url: https://api-snap.com
license:
name: Proprietary
servers:
- url: https://api-snap.com
description: Production server
security:
- BearerAuth: []
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: 'API key obtained from your API Snap dashboard. Pass as `Authorization: Bearer <key>` header or as `?api_key=<key>` query parameter.'
schemas:
Error:
type: object
properties:
error:
type: string
description: Human-readable error message
example: example
required:
- error
RateLimitError:
type: object
properties:
error:
type: string
example: Rate limit exceeded
usage:
type: integer
description: Number of API calls used this month
example: 1
limit:
type: integer
description: Monthly call limit for your plan
example: 1
upgrade_url:
type: string
format: uri
description: URL to upgrade your plan
example: https://example.com
responses:
Unauthorized:
description: Missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: 'API key required. Pass via Authorization: Bearer <key> header or ?api_key= query param.'
RateLimitExceeded:
description: Monthly API call limit reached
content:
application/json:
schema:
$ref: '#/components/schemas/RateLimitError'
headers:
X-RateLimit-Limit:
schema:
type: integer
description: Monthly call limit
X-RateLimit-Remaining:
schema:
type: integer
description: Remaining calls this month
paths:
/api/qr:
get:
operationId: generateQrCode
summary: Generate QR Code
description: Generate a QR code image for any text or URL. Returns PNG or SVG.
tags:
- Images
parameters:
- name: data
in: query
description: The text or URL to encode in the QR code. Also accepted as `url`.
required: true
schema:
type: string
example: https://example.com
- name: size
in: query
description: Width/height of the QR code in pixels (max 1000).
required: false
schema:
type: integer
default: 300
maximum: 1000
minimum: 1
example: 300
- name: format
in: query
description: Output format.
required: false
schema:
type: string
enum:
- png
- svg
default: png
example: png
- name: dark
in: query
description: Hex color for dark (foreground) modules.
required: false
schema:
type: string
default: '#000000'
example: '#000000'
- name: light
in: query
description: Hex color for light (background) modules.
required: false
schema:
type: string
default: '#ffffff'
example: '#ffffff'
responses:
'200':
description: QR code image
content:
image/png:
schema:
type: string
format: binary
image/svg+xml:
schema:
type: string
'400':
description: Missing or invalid parameters
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
GenerateQrCode400Example:
summary: Default generateQrCode 400 response
x-microcks-default: true
value:
error: Bad request
message: Invalid parameters
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimitExceeded'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/resize:
post:
operationId: resizeImage
summary: Resize and Convert Images
description: Resize and/or convert images to PNG, WebP, JPEG, or AVIF. Accepts multipart form data (with an `image` file field) or a JSON body with a base64-encoded image or image URL.
tags:
- Images
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
image:
type: string
format: binary
description: The image file to resize.
width:
type: integer
description: Target width in pixels (max 4096).
maximum: 4096
height:
type: integer
description: Target height in pixels (max 4096).
maximum: 4096
format:
type: string
enum:
- png
- jpeg
- jpg
- webp
- avif
default: png
quality:
type: integer
description: "Output quality (1–100). Applies to JPEG, WebP, AVIF."
minimum: 1
maximum: 100
default: 80
fit:
type: string
enum:
- cover
- contain
- fill
- inside
- outside
default: cover
description: How to fit the image within the target dimensions.
required:
- image
examples:
ResizeImageRequestExample:
summary: Default resizeImage request
x-microcks-default: true
value:
image: iVBORw0KGgoAAAANSUhEUgAA...
width: 300
height: 200
format: png
quality: 80
fit: cover
application/json:
schema:
type: object
properties:
image:
type: string
description: Base64-encoded image data.
url:
type: string
format: uri
description: URL of the image to fetch and resize.
width:
type: integer
maximum: 4096
height:
type: integer
maximum: 4096
format:
type: string
enum:
- png
- jpeg
- jpg
- webp
- avif
default: png
quality:
type: integer
minimum: 1
maximum: 100
default: 80
fit:
type: string
enum:
- cover
- contain
- fill
- inside
- outside
default: cover
examples:
ResizeImageRequestExample:
summary: Default resizeImage request
x-microcks-default: true
value: {}
responses:
'200':
description: Resized image binary
content:
image/png:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/webp:
schema:
type: string
format: binary
image/avif:
schema:
type: string
format: binary
'400':
description: Missing image input or invalid parameters
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
ResizeImage400Example:
summary: Default resizeImage 400 response
x-microcks-default: true
value:
error: Bad request
message: Invalid parameters
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimitExceeded'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/screenshot:
get:
operationId: captureScreenshot
summary: Capture Webpage Screenshot
description: Capture a screenshot of any publicly accessible URL. Returns PNG or JPEG.
tags:
- Browser
parameters:
- name: url
in: query
description: The URL of the webpage to screenshot.
required: true
schema:
type: string
format: uri
example: https://example.com
- name: width
in: query
description: Viewport width in pixels (max 1920).
required: false
schema:
type: integer
default: 1280
maximum: 1920
minimum: 1
example: 1280
- name: height
in: query
description: Viewport height in pixels (max 1080).
required: false
schema:
type: integer
default: 720
maximum: 1080
minimum: 1
example: 720
- name: format
in: query
description: Image output format.
required: false
schema:
type: string
enum:
- png
- jpeg
default: png
example: png
- name: full_page
in: query
description: Capture the full scrollable page instead of only the viewport.
required: false
schema:
type: boolean
default: false
example: false
responses:
'200':
description: Screenshot image
content:
image/png:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
'400':
description: Missing or invalid URL
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
CaptureScreenshot400Example:
summary: Default captureScreenshot 400 response
x-microcks-default: true
value:
error: Bad request
message: Invalid parameters
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimitExceeded'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/pdf:
post:
operationId: htmlToPdf
summary: Convert HTML to PDF
description: Convert an HTML string to a downloadable PDF file.
tags:
- Documents
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- html
properties:
html:
type: string
description: HTML content to convert to PDF.
title:
type: string
description: Document title, used as the PDF filename.
default: Document
example:
html: <h1>Hello World</h1><p>This is my PDF content.</p>
title: My Document
responses:
'200':
description: PDF file
content:
application/pdf:
schema:
type: string
format: binary
headers:
Content-Disposition:
schema:
type: string
description: attachment; filename="<title>.pdf"
'400':
description: Missing html field
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
HtmlToPdf400Example:
summary: Default htmlToPdf 400 response
x-microcks-default: true
value:
error: Bad request
message: Invalid parameters
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimitExceeded'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/hash:
get:
operationId: hashStringGet
summary: Hash a String (GET)
description: Compute a cryptographic hash of a string using the specified algorithm.
tags:
- Security
parameters:
- name: text
in: query
description: The string to hash.
required: true
schema:
type: string
example: Hello World
- name: algorithm
in: query
description: Hash algorithm to use.
required: false
schema:
type: string
enum:
- md5
- sha1
- sha256
- sha512
- sha384
- sha3-256
- sha3-512
default: sha256
example: sha256
- name: encoding
in: query
description: Output encoding.
required: false
schema:
type: string
enum:
- hex
- base64
- base64url
default: hex
example: hex
responses:
'200':
description: Hash result
content:
application/json:
schema:
type: object
properties:
hash:
type: string
description: The computed hash value.
algorithm:
type: string
encoding:
type: string
example:
hash: a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e
algorithm: sha256
encoding: hex
'400':
description: Missing text or invalid algorithm/encoding
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
HashStringGet400Example:
summary: Default hashStringGet 400 response
x-microcks-default: true
value:
error: Bad request
message: Invalid parameters
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimitExceeded'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: hashStringPost
summary: Hash a String (POST)
description: Compute a cryptographic hash of a string via JSON body. Useful for hashing large inputs.
tags:
- Security
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- text
properties:
text:
type: string
description: The string to hash.
algorithm:
type: string
enum:
- md5
- sha1
- sha256
- sha512
- sha384
- sha3-256
- sha3-512
default: sha256
encoding:
type: string
enum:
- hex
- base64
- base64url
default: hex
examples:
HashStringPostRequestExample:
summary: Default hashStringPost request
x-microcks-default: true
value:
text: Sample text
algorithm: sha256
encoding: hex
responses:
'200':
description: Hash result
content:
application/json:
schema:
type: object
properties:
hash:
type: string
algorithm:
type: string
encoding:
type: string
examples:
HashStringPost200Example:
summary: Default hashStringPost 200 response
x-microcks-default: true
value:
hash: example
algorithm: sha256
encoding: hex
'400':
description: Missing text or invalid algorithm
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
HashStringPost400Example:
summary: Default hashStringPost 400 response
x-microcks-default: true
value:
error: Bad request
message: Invalid parameters
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimitExceeded'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/uuid:
get:
operationId: generateId
summary: Generate UUIDs and Unique IDs
description: 'Generate one or more unique identifiers in various formats: UUID v4, nanoid, hex token, base64, numeric, or timestamp-prefixed.'
tags:
- Utilities
parameters:
- name: format
in: query
description: ID format to generate.
required: false
schema:
type: string
enum:
- uuid
- v4
- nanoid
- nanoid-short
- hex
- base64
- numeric
- timestamp
default: uuid
example: uuid
- name: count
in: query
description: "Number of IDs to generate (1–100)."
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 1
example: 1
- name: prefix
in: query
description: Optional string prefix to prepend to each generated ID.
required: false
schema:
type: string
example: user_
responses:
'200':
description: Generated ID(s). Returns `id` (string) when count=1, or `ids` (array) when count>1.
content:
application/json:
schema:
oneOf:
- type: object
properties:
id:
type: string
description: Single generated ID.
- type: object
properties:
ids:
type: array
items:
type: string
description: Array of generated IDs.
examples:
single:
value:
id: 550e8400-e29b-41d4-a716-446655440000
multiple:
value:
ids:
- 550e8400-e29b-41d4-a716-446655440000
- 7b3d479c-12f1-4a3e-8c5b-123456789abc
'400':
description: Invalid format parameter
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
GenerateId400Example:
summary: Default generateId 400 response
x-microcks-default: true
value:
error: Bad request
message: Invalid parameters
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimitExceeded'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/meta:
get:
operationId: extractUrlMetadata
summary: Extract URL Metadata and Open Graph Tags
description: Fetch a URL and extract its title, description, Open Graph image, favicon, and other metadata.
tags:
- Utilities
parameters:
- name: url
in: query
description: The URL to extract metadata from.
required: true
schema:
type: string
format: uri
example: https://example.com
responses:
'200':
description: Extracted metadata
content:
application/json:
schema:
type: object
properties:
url:
type: string
format: uri
title:
type: string
nullable: true
description:
type: string
nullable: true
image:
type: string
format: uri
nullable: true
siteName:
type: string
nullable: true
type:
type: string
nullable: true
favicon:
type: string
format: uri
nullable: true
themeColor:
type: string
nullable: true
author:
type: string
nullable: true
published:
type: string
format: date-time
nullable: true
examples:
ExtractUrlMetadata200Example:
summary: Default extractUrlMetadata 200 response
x-microcks-default: true
value:
url: https://example.com
title: Document
description: example
image: iVBORw0KGgoAAAANSUhEUgAA...
siteName: example
type: example
favicon: example
themeColor: example
author: example
published: example
'400':
description: Missing or invalid URL
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
ExtractUrlMetadata400Example:
summary: Default extractUrlMetadata 400 response
x-microcks-default: true
value:
error: Bad request
message: Invalid parameters
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimitExceeded'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/base64:
post:
operationId: base64EncodeDecode
summary: Base64 Encode or Decode
description: Encode a string to Base64 or decode a Base64 string back to plain text. Supports standard and URL-safe Base64.
tags:
- Utilities
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- input
properties:
input:
type: string
description: The string to encode or the Base64 string to decode.
action:
type: string
enum:
- encode
- decode
default: encode
description: Whether to encode or decode.
urlSafe:
type: boolean
default: false
description: Use URL-safe Base64 alphabet (base64url) instead of standard Base64.
examples:
encode:
value:
input: Hello, World!
action: encode
decode:
value:
input: SGVsbG8sIFdvcmxkIQ==
action: decode
responses:
'200':
description: Encoded or decoded result
content:
application/json:
schema:
type: object
properties:
result:
type: string
action:
type: string
enum:
- encode
- decode
examples:
Base64EncodeDecode200Example:
summary: Default base64EncodeDecode 200 response
x-microcks-default: true
value:
result: example
action: encode
'400':
description: Missing input or invalid base64 data
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Base64EncodeDecode400Example:
summary: Default base64EncodeDecode 400 response
x-microcks-default: true
value:
error: Bad request
message: Invalid parameters
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimitExceeded'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/jwt-decode:
post:
operationId: decodeJwt
summary: Decode a JWT Token
description: Decode a JSON Web Token (JWT) and return its header, payload, and human-readable expiry information. Does not verify the signature.
tags:
- Security
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- token
properties:
token:
type: string
description: The JWT string (header.payload.signature).
example:
token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
responses:
'200':
description: Decoded JWT
content:
application/json:
schema:
type: object
properties:
header:
type: object
description: Decoded JWT header.
additionalProperties: true
payload:
type: object
description: Decoded JWT payload.
additionalProperties: true
expired:
type: boolean
description: Whether the token has expired (only present if `exp` claim exists).
expiresAt:
type: string
format: date-time
description: ISO 8601 expiry time (only present if `exp` claim exists).
issuedAt:
type: string
format: date-time
description: ISO 8601 issued-at time (only present if `iat` claim exists).
examples:
DecodeJwt200Example:
summary: Default decodeJwt 200 response
x-microcks-default: true
value:
header: example
payload: example
expired: false
expiresAt: example
issuedAt: example
'400':
description: Missing token or invalid JWT format
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
DecodeJwt400Example:
summary: Default decodeJwt 400 response
x-microcks-default: true
value:
error: Bad request
message: Invalid parameters
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimitExceeded'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/color:
get:
operationId: convertColor
summary: Convert Color Formats
description: Convert a color between hex, RGB, HSL and get metadata like brightness and isDark. Accepts hex, rgb(), or hsl() input.
tags:
- Utilities
parameters:
- name: color
in: query
description: Color value to convert. Accepts hex (e.g. `#ff0000` or `ff0000`), RGB (e.g. `rgb(255,0,0)`), or HSL (e.g. `hsl(0,100%,50%)`).
required: true
schema:
type: string
example: '#ff0000'
responses:
'200':
description: Color in all supported formats
content:
application/json:
schema:
type: object
properties:
hex:
type: string
example: '#ff0000'
rgb:
type: object
properties:
r:
type: integer
g:
type: integer
b:
type: integer
rgbString:
type: string
example: rgb(255, 0, 0)
hsl:
type: object
properties:
h:
type: integer
s:
type: integer
l:
type: integer
hslString:
type: string
example: hsl(0, 100%, 50%)
rgba:
type: string
example: rgba(255, 0, 0, 1)
brightness:
type: integer
description: "Perceived brightness (0–255)."
isDark:
type: boolean
description: True if the color is perceived as dark.
examples:
ConvertColor200Example:
summary: Default conv
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/api-snap/refs/heads/main/openapi/api-snap-openapi.yml