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

import requests

url = "https://api.axiom.xyz/v1/programs"

files = {
    "elf": ("example-file", open("example-file", "rb")),
    "vmexe": ("example-file", open("example-file", "rb"))
}
headers = {"Axiom-API-Key": "<api-key>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('elf', '<string>');
form.append('vmexe', '<string>');

const options = {method: 'POST', headers: {'Axiom-API-Key': '<api-key>'}};

options.body = form;

fetch('https://api.axiom.xyz/v1/programs', 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://api.axiom.xyz/v1/programs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"elf\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vmexe\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Axiom-API-Key: <api-key>",
    "Content-Type: multipart/form-data"
  ],
]);

$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://api.axiom.xyz/v1/programs"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"elf\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vmexe\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

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

	req.Header.Add("Axiom-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.post("https://api.axiom.xyz/v1/programs")
  .header("Axiom-API-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"elf\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vmexe\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.axiom.xyz/v1/programs")

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

request = Net::HTTP::Post.new(url)
request["Axiom-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"elf\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vmexe\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

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

{
  "id": "<string>"
}

{
  "id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Program Management

Register new program

Build the program locally with cargo openvm build, then upload the resulting ELF binary together with the transpiled VMEXE. The backend computes the program’s exe_commit and verification baseline asynchronously (via a lightweight Kubernetes job) and flips the program to Ready — no cloud compilation happens.

Example Usage

curl -X POST "https://api.axiom.xyz/v1/programs?config_id=cfg_xxxx" \
  -H "Axiom-API-Key: your-api-key" \
  -F "elf=@program.elf" \
  -F "vmexe=@program.vmexe" \
  -F "project_name=My Project"

POST

programs

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

import requests

url = "https://api.axiom.xyz/v1/programs"

files = {
    "elf": ("example-file", open("example-file", "rb")),
    "vmexe": ("example-file", open("example-file", "rb"))
}
headers = {"Axiom-API-Key": "<api-key>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('elf', '<string>');
form.append('vmexe', '<string>');

const options = {method: 'POST', headers: {'Axiom-API-Key': '<api-key>'}};

options.body = form;

fetch('https://api.axiom.xyz/v1/programs', 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://api.axiom.xyz/v1/programs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"elf\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vmexe\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Axiom-API-Key: <api-key>",
    "Content-Type: multipart/form-data"
  ],
]);

$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://api.axiom.xyz/v1/programs"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"elf\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vmexe\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

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

	req.Header.Add("Axiom-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.post("https://api.axiom.xyz/v1/programs")
  .header("Axiom-API-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"elf\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vmexe\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.axiom.xyz/v1/programs")

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

request = Net::HTTP::Post.new(url)
request["Axiom-API-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"elf\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vmexe\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

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

{
  "id": "<string>"
}

{
  "id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Axiom-API-Key

string

header

required

Query Parameters

config_id

string

required

The ID of the config to use (format: cfg_{ulid})

program_name

string | null

Optional custom name for the program

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

default_num_gpus

integer

default:8

Default number of GPUs to use for proofs of this program

Required range: 1 <= x <= 10000

Body

multipart/form-data

elf

file

required

Pre-built ELF binary

vmexe

file

required

Transpiled VMEXE file

Response

Successful Response

Generic response for POST operations.

string

required

⌘I

Using the API

REST APIs

SDKs

Support and Configuration

Register new program

Example Usage

Authorizations

Query Parameters

Body

Response