apyhub
DEVELOPER TOOLS · SECURITY & PRIVACY

Generate UUID API

What it does

UUID Generator creates version 1 or version 4 UUIDs on demand. Send an optional version query parameter with 1 or 4, and get back a response containing the generated uuid string and the version used.

Use it when you need unique identifiers for database rows, distributed systems, API resources, test fixtures, or temporary object keys. Version 4 is the default, so you can generate random UUIDs without sending any input. If you need time-based UUIDs for systems that rely on ordering or traceability, request version 1 instead.

UUID Generator keeps the contract simple: one GET endpoint, one optional parameter, and a minimal JSON response. That makes it easy to drop into backend services, scripts, and internal tooling where you need standards-based identifiers without pulling in extra libraries.

GET
Generate a UUID v1 or v4
http://localhost:8080/dosvak/uuid
QUICKSTARTGUIDE

Quickstart

Get a UUID in the default version by calling the endpoint with the version query parameter omitted.

curl -X GET "http://localhost:8080/dosvak/uuid" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with uuid as a string and version as an integer.

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "version": 4
}
TRY ITLIVE · 10 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Generates a UUID and returns it as a JSON object with the generated uuid string and its version integer. Use the version query parameter to choose UUID v1 or v4; if omitted, the default is v4.

Query Parameter(s)

AttributeTypeMandatoryDescription
versionIntegerNoAllowed values: 1, 4.<br>Default: 4.

Response

Returns a JSON object with a uuid string field and a version integer field.

ParameterTypeMandatoryDescription
uuidStringYesThe generated UUID string.
versionIntegerYesThe UUID version used to generate uuid.

Query parameters

Name
Type
Description
versionOPTIONAL
integer
1 · 4
DEFAULT 4
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.