---
title: "Decode IDs: Snowflake, MongoDB ObjectId, KSUID, TypeID, ULID, UUID and CUID2 — timestamp, machine fields and randomness."
method: POST
path: "/api/v1/id-decoder"
tags: ["Encoders & Decoders"]
---

# Decode IDs: Snowflake, MongoDB ObjectId, KSUID, TypeID, ULID, UUID and CUID2 — timestamp, machine fields and randomness.

`POST /api/v1/id-decoder`

## Request

- Base URL: `https://programmes.net`
- URL: `https://programmes.net/api/v1/id-decoder`
- Auth: none declared

ID Decoder. Operations: `decode` — Detect each ID's format and take it apart (one ID per line, up to 200).

## Request body

- IdDecoderDecode: Detect each ID's format and take it apart (one ID per line, up to 200).
  - `operation` 'decode', required
  - `input` string: One or more IDs, one per line.
  - `options` object
    - `kind` 'auto' | 'uuid' | 'ulid' | 'typeid' | 'ksuid' | 'objectid' | 'snowflake' | 'cuid2': Force a format instead of detecting it from the shape.
    - `epoch` 'twitter' | 'discord': Which epoch to read Snowflake IDs with.

## Response `200`

The operation ran.

- object
  - `ok` unknown, required
  - `tool` 'id-decoder', required
  - `operation` 'decode', required
  - `result` unknown, required

## Other responses

- `400`: The request is not valid (https://programmes.net/api#invalid-request); The tool has no such operation (https://programmes.net/api#unknown-operation)
- `404`: No such tool (https://programmes.net/api#unknown-tool)
- `413`: The request or its input is too large (https://programmes.net/api#content-too-large)
- `415`: The body must be JSON (https://programmes.net/api#unsupported-media-type)
- `422`: An option is missing, of the wrong type or out of range (https://programmes.net/api#invalid-options); This call needs more CPU than one API call may use (https://programmes.net/api#refused); The operation could not process the input (https://programmes.net/api#tool-error)
- `429`: Too many requests (https://programmes.net/api#rate-limited)
- `500`: Internal error (https://programmes.net/api#internal-error)

---

[API](https://skmtc.dev/programmes/apis/programmes-net-api.md) · [All operations](https://skmtc.dev/programmes/apis/programmes-net-api/llms.txt) · [OpenAPI document](https://skmtc.dev/programmes/apis/programmes-net-api/revisions/aa939784a2e6?raw)
