Register Program

curl --request POST \
  --url https://api.axiom.xyz/v1/programs \
  --header 'Axiom-API-Key: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form program=@example-file \
  --form config=@example-file

{
  "id": "<string>"
}

Program Management

Register new program

Upload and register a new OpenVM program for compilation.

The program must be uploaded as a tar.gz archive containing the guest program source code and dependencies. You can either provide a config_id for an existing configuration or upload a new config file.

Example Usage

curl -X POST "https://api.axiom.xyz/v1/programs" \
  -H "Axiom-API-Key: your-api-key" \
  -F "program=@my_program.tar.gz" \
  -F "config_id=cfg_xxxx" \
  -F "program_path=." \
  -F "cargo_root_path=." \
  -F "project_name=My Project"

POST

/

v1

/

programs

Register Program

curl --request POST \
  --url https://api.axiom.xyz/v1/programs \
  --header 'Axiom-API-Key: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form program=@example-file \
  --form config=@example-file

{
  "id": "<string>"
}

Authorizations

Axiom-API-Key

string

header

required

Query Parameters

config_id

string | null

The UUID of the config to use

program_path

string

default:.

The relative path from the uploaded directory root to the guest program

cargo_root_path

string

default:.

The relative path from the uploaded directory root to the cargo workspace root

bin_name

string | null

The name of the binary to build. If not provided, the build will succeed only if there is one binary in the workspace.

commit_sha

string | null

If applicable, the commit sha of the guest program

project_id

string | null

The ID of the project to associate this program with. If not provided, a new project will be created.

project_name

string | null

Name for new project if project_id is not provided

Body

multipart/form-data

program

file

required

A tar.gz archive of a directory containing the guest program and its dependencies

config

file | null

A toml file with all the parameters to configure the proving system

Response

Successful Response

Generic response for POST operations.

id

string

required

Download build logs List proofs