Catalog/workflow-idempotency-key

Workflow

Idempotency key generation API

Derives a stable SHA-256 idempotency key from a canonicalized request (namespace + method + path + key-sorted body) so identical requests collapse to one key regardless of field order. Answers 'What idempotency key should this request use?', 'Are these two requests the same?'.

Price$0.02per request
MethodPOST
Route/v1/workflow/idempotency-key
StatusLive
MIME typeapplication/json
Rate limit120/minute
Cache0s public
idempotencykeydedupehashcanonicalrequestsha256workflow
API URLhttps://x402.hexl.dev/v1/workflow/idempotency-key
Integration docs
Example request
{
  "method": "POST",
  "path": "/orders",
  "body": {
    "b": 2,
    "a": 1
  }
}
Example response
{
  "idempotencyKey": "48c16ee60a8140637ad3f8d043b671819025ab45701fd86e4ed16ce7543cde79",
  "short": "48c16ee60a814063",
  "canonicalInput": "{\"ns\":\"\",\"method\":\"POST\",\"path\":\"/orders\",\"body\":{\"a\":1,\"b\":2}}",
  "interpretation": "Stable idempotency key derived from canonicalized POST /orders; identical requests yield this exact key."
}
Input schema
{
  "type": "object",
  "required": [],
  "properties": {
    "method": {
      "type": "string",
      "examples": [
        "POST"
      ]
    },
    "path": {
      "type": "string",
      "examples": [
        "/orders"
      ]
    },
    "body": {
      "examples": [
        {
          "b": 2,
          "a": 1
        }
      ]
    },
    "namespace": {
      "type": "string"
    }
  }
}
Output schema
{
  "type": "object",
  "additionalProperties": true
}