Skip to API content
Birdor API v1

API reference · v1

Hash or HMAC data

Compute MD5, SHA-1, SHA-256, SHA-384 and/or SHA-512 digests, or HMAC with a key, of text, hex or base64 input in one call. Use it to checksum files, derive cache keys, or check an HMAC your code produces. Input and key are processed in memory only. Requires a credential with tools.run; every accepted call consumes one monthly unit, including business 4xx/5xx. Sensitive: request bodies are processed in memory only and are never stored, logged or hashed into usage records.

POST/v1/run/hash/digest

Access requirements

Health, metadata, changelog and waitlist routes are public. Catalog reads (GET /v1/tools, /v1/tools/{id}, /v1/colors/*) and POST /v1/tools/query require a tools.read credential; POST /v1/run/* requires tools.run. There is no anonymous access to these routes: send an API key (Bearer OR X-API-Key) from your server, or use the HttpOnly main-site session plus workspace selection and same-origin Origin. Never combine credentials. Every admitted call is metered. Ingress and workspace/actor minute/month limits are separate; waitlist has its own policy.

Implemented interfaces and development screens do not imply public production availability, paid access or a completed payment integration. Confirm access with Birdor before connecting an application. No paid Pro service, activation or cross-device sync is currently delivered. We are validating one repeatable task before building a paid offer.

Parameters

FieldDescription
AuthorizationstringOptionalBearer API key with tools.run; alternatively X-API-Key. One of the credentials is required.
X-API-KeystringOptionalAlternative to Authorization; never send both.
X-Birdor-Workspace-IDstringOptionalRequired with the site session; optional and matching with an API key.
X-Birdor-Project-IDstringOptionalOptional owned project; a project-bound key cannot select another project.

Request body

Send JSON with Content-Type: application/json.

FieldDescription
inputstringRequiredData to hash, at most 30000 characters (the whole request body is capped at 32768 bytes).
inputEncodingutf8 | hex | base64OptionalHow input is encoded: utf8 (default), hex or base64. Hash binary data by sending it as hex or base64.
algorithmsarrayOptionalOne or more of MD5, SHA-1, SHA-256, SHA-384, SHA-512; default ["SHA-256"]. MD5 and SHA-1 are for checksums and legacy interop only.
outputEncodinghex | base64OptionalDigest encoding: hex (lowercase, default) or base64.
hmacKeystringOptionalWhen set, compute HMAC with this key instead of a plain digest (not available with MD5). Used in memory for this request only; never stored or logged.
hmacKeyEncodingutf8 | hex | base64OptionalHow hmacKey is encoded: utf8 (default), hex or base64.

Request example

1. Set the base URL

Request example
curl --request POST "$BIRDOR_API_BASE_URL/v1/run/hash/digest" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $BIRDOR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "input": "what do ya want for nothing?",
  "algorithms": [
    "SHA-256"
  ],
  "hmacKey": "Jefe"
}'

Examples are copied only; this page does not send API requests.

Responses

Illustrative response. Values vary by environment and time.

200Success
HTTP 200
{
  "ok": true,
  "data": {
    "mode": "hmac",
    "inputBytes": 28,
    "outputEncoding": "hex",
    "digests": [
      {
        "algorithm": "SHA-256",
        "value": "5bdcc146bf60754e6a042426089575c75a003f089d2739839dec58b964ec3843"
      }
    ]
  },
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
400Invalid JSON, schema validation failure (field paths/codes only, never input values) or ambiguous credentials
HTTP 400
{
  "ok": false,
  "code": "VALIDATION_ERROR",
  "message": "Invalid request parameters",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
401Missing, expired, rotated, revoked or invalid credential; there is no anonymous access
HTTP 401
{
  "ok": false,
  "code": "UNAUTHENTICATED",
  "message": "API access denied",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
403Key lacks tools.run, or workspace/project/member policy or site Origin denied
HTTP 403
{
  "ok": false,
  "code": "FORBIDDEN",
  "message": "API access denied",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
405Only POST is supported; rejected before admission
HTTP 405
{
  "ok": false,
  "code": "METHOD_NOT_ALLOWED",
  "message": "Method not allowed",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
408Body read exceeds five seconds; before admission
HTTP 408
{
  "ok": false,
  "code": "REQUEST_TIMEOUT",
  "message": "Request body timeout or aborted",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
413Body exceeds 32768 bytes; before admission
HTTP 413
{
  "ok": false,
  "code": "PAYLOAD_TOO_LARGE",
  "message": "Request body too large",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
415Content-Type must be application/json; before admission
HTTP 415
{
  "ok": false,
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "message": "JSON content type required",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
429Ingress, workspace/actor minute or monthly quota exceeded; inspect code and Retry-After
HTTP 429
{
  "ok": false,
  "code": "QUOTA_EXCEEDED",
  "message": "API request limit exceeded",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
500Unexpected operation failure; details are never echoed
HTTP 500
{
  "ok": false,
  "code": "OPERATION_FAILED",
  "message": "Operation failed",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
503Authentication/metering dependency unavailable
HTTP 503
{
  "ok": false,
  "code": "API_GATEWAY_UNAVAILABLE",
  "message": "API access denied",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
422INVALID_INPUT_ENCODING: input cannot be decoded with inputEncoding; INVALID_KEY_ENCODING: hmacKey cannot be decoded with hmacKeyEncoding; HMAC_ALGORITHM_UNSUPPORTED: MD5 cannot be combined with hmacKey
HTTP 422
{
  "ok": false,
  "code": "INVALID_INPUT_ENCODING",
  "message": "input cannot be decoded with inputEncoding",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
Error handling

Example response fields

Fields shown in this example; optional fields can be omitted. Array rows describe the first example element.

okboolean
Application success flag.
dataobject
Endpoint-specific result.
data.modestring
Day-of-month/day-of-week rule applied.
data.inputBytesnumber
Endpoint-specific example value.
data.outputEncodingstring
Endpoint-specific example value.
data.digestsarray
Endpoint-specific example value.
data.digests[].algorithmstring
HMAC hash algorithm.
data.digests[].valuestring
Token value.
request_idstring
Origin-response identifier matching X-Request-ID; a shared HTTP cache may replay the original trace.
timestampstring
Response creation timestamp.