Skip to main content
POST
/
atlantic-query
Submit a Atlantic query
curl --request POST \
  --url 'https://atlantic.api.herodotus.cloud/docs/atlantic-query?apiKey=' \
  --header 'Content-Type: multipart/form-data' \
  --form declaredJobSize=XS \
  --form externalId= \
  --form layout=auto \
  --form cairoVm=rust \
  --form cairoVersion=cairo0 \
  --form result=PROOF_GENERATION \
  --form mockFactHash=false \
  --form network=TESTNET \
  --form hints=herodotus_evm_grower \
  --form programHash= \
  --form programFile='@example-file' \
  --form inputFile='@example-file' \
  --form pieFile='@example-file' \
  --form bucketId= \
  --form bucketJobIndex=null
{
  "atlanticQueryId": "<string>"
}
Please use this endpoint through our Swagger UI!Sending it from these docs will not work because of a Mintlify (our documentation platform) issue with uploading files.

Authorizations

​
apiKey
string
query
required

Body

multipart/form-data
​
declaredJobSize
enum<string>
required

Smaller jobs are cheaper, however your job might fail if you choose a job size that is too small.

Available options:
XS,
S,
M,
L
​
externalId
string
default:""

The external id of the query, you can use it to track the query

​
layout
enum<string>
default:auto
Available options:
auto,
plain,
recursive,
recursive_with_poseidon,
recursive_large_output,
all_solidity,
all_cairo,
dynamic,
small,
dex,
starknet,
starknet_with_keccak
​
cairoVm
enum<string>
default:rust
Available options:
rust,
python
​
cairoVersion
enum<string>
default:cairo0
Available options:
cairo0,
cairo1
​
result
enum<string>
default:PROOF_GENERATION

Describe what you want to achieve

Available options:
TRACE_GENERATION,
PROOF_GENERATION,
PROOF_VERIFICATION_ON_L1,
PROOF_VERIFICATION_ON_L2,
PROOF_VERIFICATION_ON_APE_CHAIN,
PROOF_VERIFICATION_ON_WORLD_CHAIN
​
mockFactHash
enum<string>
default:false

Used for proof verification, if true, a fact hash will be mocked

Available options:
false,
true
​
network
enum<string>
default:TESTNET
Available options:
MAINNET,
TESTNET
​
hints
Available options:
herodotus_evm_grower,
herodotus_sn_grower
​
programHash
string
default:""

To use the program you are interested in, you must first register it. Registration occurs when you upload the program file for the first time.

​
programFile
file
​
inputFile
file
​
pieFile
file
​
bucketId
string | null
default:""

(Applicative Recursion) The id of the bucket you want to submit the query to

​
bucketJobIndex
number | null

(Applicative Recursion) The index of the job inside the bucket

Response

Default Response

​
atlanticQueryId
string
required