• /v1/proof-generation

This endpoint submits query for proof generation only.

How to use?

This endpoint requires the pie.zip file as input, along with parameters to define the layout and the prover to be used.

Sending Request

  • Query Parameters
    • apiKey (string, required)
  • Request Body
    • pieFile (file - .zip, required) - pie.zip generated e.g. using cairo-run or with /trace-generation endpoint (but in that case you should probably send /trace-generation-proof-generation query instead)
    • prover (string, required, default: starkware_sharp) - Prover to be used. If you want to use our stone instance - contact us.
    • layout (string, required, default: auto) - Cairo layout of your pie file. Available layouts are:
      • auto - automatically detect layout based on builtins usage
      • recursive
      • recursive_with_poseidon
      • small
      • dex
      • starknet
      • starknet_with_keccak
      • dynamic

Responses

  • Success (201 created)

    • Content-Type: application/json
    • Response Body
    {
        "atlanticQueryId": "string"
    }
    
    • You can use this atlanticQueryId to check status of that request.
  • Error responses

    • 400 Bad Request - Indicates that parameters are invalid, e.g. not providing layout at all.
    • 500 Internal Server Error - This says error is on our side.

Example Request

curl -X 'POST' \
  'https://atlantic.api.herodotus.cloud/v1/proof-generation?apiKey=<api-key>' \
  -H 'accept: application/json' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pieFile=@pie.zip;type=application/zip' \
  -F 'layout=recursive_with_poseidon' \
  -F 'prover=starkware_sharp'