Get query by dedup ID

Retrieve an Atlantic STARK proof query using your custom deduplication identifier

GET /atlantic-query-by-dedup-id

Get Atlantic Query by Dedup ID

cURL

curl --request GET \
  --url https://atlantic.api.herodotus.cloud/atlantic-query-by-dedup-id \
  --header 'api-key: <api-key>'

import requests

url = "https://atlantic.api.herodotus.cloud/atlantic-query-by-dedup-id"

headers = {"api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'api-key': '<api-key>'}};

fetch('https://atlantic.api.herodotus.cloud/atlantic-query-by-dedup-id', 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://atlantic.api.herodotus.cloud/atlantic-query-by-dedup-id",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://atlantic.api.herodotus.cloud/atlantic-query-by-dedup-id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://atlantic.api.herodotus.cloud/atlantic-query-by-dedup-id")
  .header("api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://atlantic.api.herodotus.cloud/atlantic-query-by-dedup-id")

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

request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'

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

200

{
  "atlanticQuery": {
    "id": "<string>",
    "externalId": "<string>",
    "dedupId": "<string>",
    "transactionId": "<string>",
    "step": "<string>",
    "programHash": "<string>",
    "integrityFactHash": "<string>",
    "sharpFactHash": "<string>",
    "layout": "<string>",
    "isFactMocked": true,
    "isProofMocked": true,
    "steps": [
      "<string>"
    ],
    "errorReason": "<string>",
    "submittedByClient": "<string>",
    "projectId": "<string>",
    "submittedByWallet": "<string>",
    "bucketId": "<string>",
    "bucketJobIndex": -1,
    "customerName": "<string>",
    "isJobSizeValid": true,
    "retryCount": -1,
    "createdAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "MISSING_API_KEY"
}

{
  "message": "ATLANTIC_QUERY_NOT_FOUND"
}

{}

Query Deduplication

Atlantic supports query deduplication through the dedupId parameter. When submitting a query, you can provide a custom dedupId to:

• Avoid duplicate processing of identical queries
• Track and retrieve queries using your own identifier
• Reference queries across your application consistently

This endpoint allows you to retrieve a query using your custom dedupId and projectId, which is particularly useful when you want to:

• Ensure idempotent query submissions
• Retrieve query results using your own tracking identifiers
• Check if a query with a specific dedup ID already exists before submitting a new one

Usage

Provide both the dedupId and projectId as query parameters to retrieve the Atlantic query details.

Authorizations

api-key · string · header · required

Query Parameters

dedupId · string · required

apiKey · string

Response

200

application/json

Default Response

atlanticQuery · object · required

Show child attributes