Decommitment only

Submit a decommitment request for an HDP task when running HDP and generating PIE locally. You can optionally provide hdp_output and program_hash, and if not provided, they will be automatically fetched from Atlantic storage using the atlantic_query_id.

POST /tasks/decommitment

Decommitment only

cURL

curl --request POST \
  --url https://staging.hdp.api.herodotus.cloud/tasks/decommitment \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "atlantic_query_id": "01KA1F1FY93BP2MWF6BP4Y3GW1",
  "destination_chain_id": "0x534e5f5345504f4c4941",
  "hdp_output": {
    "mmr_metas": [
      {
        "Poseidon": {
          "chain_id": "0xaa37dc",
          "id": "0x30314b345136303433515133424b4d42324e31394d4443595757",
          "root": "0x6e7be7495a7126588df5ce10e090b27ea87357b966cc5b4143d0845ee15af0e",
          "size": "0x2644"
        }
      },
      {
        "Keccak": {
          "chain_id": "0xaa36a7",
          "id": "0x30314a4d484d31413242354d38455336505a57524a505354374d",
          "root_high": "0xb8eb37ccfb5d11f205555666",
          "root_low": "0x8df74acdc8c1fc184081e4a2ec4ccca78c03a541",
          "size": "0x0a813"
        }
      }
    ],
    "output_tree_root_high": "0x109640f2deb15a8d29ee5bb754a2943a",
    "output_tree_root_low": "0xc103b036a12f8f9307b062b11181a726",
    "task_hash_high": "0x89bb92c8c305fd8df0fbcc19602339ac",
    "task_hash_low": "0x56839c1e7f817be047794dbdc727585f"
  },
  "program_hash": "0x34a16478e83f69c4f0bcdb7549d32f92c9b7776bb3f71da06de334f1871eba0",
  "webhook_url": "https://example.com/webhook"
}
'

import requests

url = "https://staging.hdp.api.herodotus.cloud/tasks/decommitment"

payload = {
    "atlantic_query_id": "01KA1F1FY93BP2MWF6BP4Y3GW1",
    "destination_chain_id": "0x534e5f5345504f4c4941",
    "hdp_output": {
        "mmr_metas": [{ "Poseidon": {
                    "chain_id": "0xaa37dc",
                    "id": "0x30314b345136303433515133424b4d42324e31394d4443595757",
                    "root": "0x6e7be7495a7126588df5ce10e090b27ea87357b966cc5b4143d0845ee15af0e",
                    "size": "0x2644"
                } }, { "Keccak": {
                    "chain_id": "0xaa36a7",
                    "id": "0x30314a4d484d31413242354d38455336505a57524a505354374d",
                    "root_high": "0xb8eb37ccfb5d11f205555666",
                    "root_low": "0x8df74acdc8c1fc184081e4a2ec4ccca78c03a541",
                    "size": "0x0a813"
                } }],
        "output_tree_root_high": "0x109640f2deb15a8d29ee5bb754a2943a",
        "output_tree_root_low": "0xc103b036a12f8f9307b062b11181a726",
        "task_hash_high": "0x89bb92c8c305fd8df0fbcc19602339ac",
        "task_hash_low": "0x56839c1e7f817be047794dbdc727585f"
    },
    "program_hash": "0x34a16478e83f69c4f0bcdb7549d32f92c9b7776bb3f71da06de334f1871eba0",
    "webhook_url": "https://example.com/webhook"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    atlantic_query_id: '01KA1F1FY93BP2MWF6BP4Y3GW1',
    destination_chain_id: '0x534e5f5345504f4c4941',
    hdp_output: {
      mmr_metas: [
        {
          Poseidon: {
            chain_id: '0xaa37dc',
            id: '0x30314b345136303433515133424b4d42324e31394d4443595757',
            root: '0x6e7be7495a7126588df5ce10e090b27ea87357b966cc5b4143d0845ee15af0e',
            size: '0x2644'
          }
        },
        {
          Keccak: {
            chain_id: '0xaa36a7',
            id: '0x30314a4d484d31413242354d38455336505a57524a505354374d',
            root_high: '0xb8eb37ccfb5d11f205555666',
            root_low: '0x8df74acdc8c1fc184081e4a2ec4ccca78c03a541',
            size: '0x0a813'
          }
        }
      ],
      output_tree_root_high: '0x109640f2deb15a8d29ee5bb754a2943a',
      output_tree_root_low: '0xc103b036a12f8f9307b062b11181a726',
      task_hash_high: '0x89bb92c8c305fd8df0fbcc19602339ac',
      task_hash_low: '0x56839c1e7f817be047794dbdc727585f'
    },
    program_hash: '0x34a16478e83f69c4f0bcdb7549d32f92c9b7776bb3f71da06de334f1871eba0',
    webhook_url: 'https://example.com/webhook'
  })
};

fetch('https://staging.hdp.api.herodotus.cloud/tasks/decommitment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging.hdp.api.herodotus.cloud/tasks/decommitment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'atlantic_query_id' => '01KA1F1FY93BP2MWF6BP4Y3GW1',
    'destination_chain_id' => '0x534e5f5345504f4c4941',
    'hdp_output' => [
        'mmr_metas' => [
                [
                                'Poseidon' => [
                                                                'chain_id' => '0xaa37dc',
                                                                'id' => '0x30314b345136303433515133424b4d42324e31394d4443595757',
                                                                'root' => '0x6e7be7495a7126588df5ce10e090b27ea87357b966cc5b4143d0845ee15af0e',
                                                                'size' => '0x2644'
                                ]
                ],
                [
                                'Keccak' => [
                                                                'chain_id' => '0xaa36a7',
                                                                'id' => '0x30314a4d484d31413242354d38455336505a57524a505354374d',
                                                                'root_high' => '0xb8eb37ccfb5d11f205555666',
                                                                'root_low' => '0x8df74acdc8c1fc184081e4a2ec4ccca78c03a541',
                                                                'size' => '0x0a813'
                                ]
                ]
        ],
        'output_tree_root_high' => '0x109640f2deb15a8d29ee5bb754a2943a',
        'output_tree_root_low' => '0xc103b036a12f8f9307b062b11181a726',
        'task_hash_high' => '0x89bb92c8c305fd8df0fbcc19602339ac',
        'task_hash_low' => '0x56839c1e7f817be047794dbdc727585f'
    ],
    'program_hash' => '0x34a16478e83f69c4f0bcdb7549d32f92c9b7776bb3f71da06de334f1871eba0',
    'webhook_url' => 'https://example.com/webhook'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://staging.hdp.api.herodotus.cloud/tasks/decommitment"

	payload := strings.NewReader("{\n  \"atlantic_query_id\": \"01KA1F1FY93BP2MWF6BP4Y3GW1\",\n  \"destination_chain_id\": \"0x534e5f5345504f4c4941\",\n  \"hdp_output\": {\n    \"mmr_metas\": [\n      {\n        \"Poseidon\": {\n          \"chain_id\": \"0xaa37dc\",\n          \"id\": \"0x30314b345136303433515133424b4d42324e31394d4443595757\",\n          \"root\": \"0x6e7be7495a7126588df5ce10e090b27ea87357b966cc5b4143d0845ee15af0e\",\n          \"size\": \"0x2644\"\n        }\n      },\n      {\n        \"Keccak\": {\n          \"chain_id\": \"0xaa36a7\",\n          \"id\": \"0x30314a4d484d31413242354d38455336505a57524a505354374d\",\n          \"root_high\": \"0xb8eb37ccfb5d11f205555666\",\n          \"root_low\": \"0x8df74acdc8c1fc184081e4a2ec4ccca78c03a541\",\n          \"size\": \"0x0a813\"\n        }\n      }\n    ],\n    \"output_tree_root_high\": \"0x109640f2deb15a8d29ee5bb754a2943a\",\n    \"output_tree_root_low\": \"0xc103b036a12f8f9307b062b11181a726\",\n    \"task_hash_high\": \"0x89bb92c8c305fd8df0fbcc19602339ac\",\n    \"task_hash_low\": \"0x56839c1e7f817be047794dbdc727585f\"\n  },\n  \"program_hash\": \"0x34a16478e83f69c4f0bcdb7549d32f92c9b7776bb3f71da06de334f1871eba0\",\n  \"webhook_url\": \"https://example.com/webhook\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://staging.hdp.api.herodotus.cloud/tasks/decommitment")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"atlantic_query_id\": \"01KA1F1FY93BP2MWF6BP4Y3GW1\",\n  \"destination_chain_id\": \"0x534e5f5345504f4c4941\",\n  \"hdp_output\": {\n    \"mmr_metas\": [\n      {\n        \"Poseidon\": {\n          \"chain_id\": \"0xaa37dc\",\n          \"id\": \"0x30314b345136303433515133424b4d42324e31394d4443595757\",\n          \"root\": \"0x6e7be7495a7126588df5ce10e090b27ea87357b966cc5b4143d0845ee15af0e\",\n          \"size\": \"0x2644\"\n        }\n      },\n      {\n        \"Keccak\": {\n          \"chain_id\": \"0xaa36a7\",\n          \"id\": \"0x30314a4d484d31413242354d38455336505a57524a505354374d\",\n          \"root_high\": \"0xb8eb37ccfb5d11f205555666\",\n          \"root_low\": \"0x8df74acdc8c1fc184081e4a2ec4ccca78c03a541\",\n          \"size\": \"0x0a813\"\n        }\n      }\n    ],\n    \"output_tree_root_high\": \"0x109640f2deb15a8d29ee5bb754a2943a\",\n    \"output_tree_root_low\": \"0xc103b036a12f8f9307b062b11181a726\",\n    \"task_hash_high\": \"0x89bb92c8c305fd8df0fbcc19602339ac\",\n    \"task_hash_low\": \"0x56839c1e7f817be047794dbdc727585f\"\n  },\n  \"program_hash\": \"0x34a16478e83f69c4f0bcdb7549d32f92c9b7776bb3f71da06de334f1871eba0\",\n  \"webhook_url\": \"https://example.com/webhook\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging.hdp.api.herodotus.cloud/tasks/decommitment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"atlantic_query_id\": \"01KA1F1FY93BP2MWF6BP4Y3GW1\",\n  \"destination_chain_id\": \"0x534e5f5345504f4c4941\",\n  \"hdp_output\": {\n    \"mmr_metas\": [\n      {\n        \"Poseidon\": {\n          \"chain_id\": \"0xaa37dc\",\n          \"id\": \"0x30314b345136303433515133424b4d42324e31394d4443595757\",\n          \"root\": \"0x6e7be7495a7126588df5ce10e090b27ea87357b966cc5b4143d0845ee15af0e\",\n          \"size\": \"0x2644\"\n        }\n      },\n      {\n        \"Keccak\": {\n          \"chain_id\": \"0xaa36a7\",\n          \"id\": \"0x30314a4d484d31413242354d38455336505a57524a505354374d\",\n          \"root_high\": \"0xb8eb37ccfb5d11f205555666\",\n          \"root_low\": \"0x8df74acdc8c1fc184081e4a2ec4ccca78c03a541\",\n          \"size\": \"0x0a813\"\n        }\n      }\n    ],\n    \"output_tree_root_high\": \"0x109640f2deb15a8d29ee5bb754a2943a\",\n    \"output_tree_root_low\": \"0xc103b036a12f8f9307b062b11181a726\",\n    \"task_hash_high\": \"0x89bb92c8c305fd8df0fbcc19602339ac\",\n    \"task_hash_low\": \"0x56839c1e7f817be047794dbdc727585f\"\n  },\n  \"program_hash\": \"0x34a16478e83f69c4f0bcdb7549d32f92c9b7776bb3f71da06de334f1871eba0\",\n  \"webhook_url\": \"https://example.com/webhook\"\n}"

response = http.request(request)
puts response.read_body

202

{
  "message": "Decommitment-only task has been queued",
  "uuid": "01J3Z3K2P4W6M8Q0A1B2C3D4E5"
}

{
  "error": "Invalid destination_chain_id format"
}

{
  "error": "Missing Herodotus Cloud X-API-KEY header"
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "taskId": "<string>"
}

Authorizations

X-API-KEY · string · header · required

Body

application/json

Decommitment request with Atlantic query ID and optional HDP output data

atlantic_query_id · string · required

destination_chain_id · string · required

Hex chain ID string (e.g., "0xa4b1", "0xaa36a7")

hdp_output · null | object

Show child attributes

Example:

{
  "mmr_metas": [
    {
      "Poseidon": {
        "chain_id": "0xaa37dc",
        "id": "0x30314b345136303433515133424b4d42324e31394d4443595757",
        "root": "0x6e7be7495a7126588df5ce10e090b27ea87357b966cc5b4143d0845ee15af0e",
        "size": "0x2644"
      }
    },
    {
      "Poseidon": {
        "chain_id": "0x534e5f5345504f4c4941",
        "id": "0x30314a56435052343150314b5759334d45563946594148343853",
        "root": "0x3a2e8b4815132c037baf334416c5585639b250f89dc470893378f9d7ffc18e4",
        "size": "0x153a8a"
      }
    },
    {
      "Keccak": {
        "chain_id": "0xaa36a7",
        "id": "0x30314a4d484d31413242354d38455336505a57524a505354374d",
        "root_high": "0x8df74acdc8c1fc184081e4a2ec4ccca7",
        "root_low": "0x8c03a541b8eb37ccfb5d11f205555666",
        "size": "0x0a813"
      }
    }
  ],
  "output_tree_root_high": "0xc103b036a12f8f9307b062b11181a726",
  "output_tree_root_low": "0x109640f2deb15a8d29ee5bb754a2943a",
  "task_hash_high": "0x56839c1e7f817be047794dbdc727585f",
  "task_hash_low": "0x89bb92c8c305fd8df0fbcc19602339ac"
}

program_hash · string | null

webhook_url · string | null

Response

202

application/json

Task accepted for decommitment

message · string · required

status · string · required

uuid · string · required