curl --request POST \
--url 'https://api.axiom.xyz/v1/programs?default_num_gpus=8' \
--header 'Axiom-API-Key: <api-key>' \
--header 'Content-Type: multipart/form-data' \
--form elf=@example-file \
--form vmexe=@example-filefrom contextlib import ExitStack
import json
import requests
url = "https://api.axiom.xyz/v1/programs?default_num_gpus=8"
headers = json.loads("{\"Axiom-API-Key\":\"<api-key>\"}")
with ExitStack() as stack:
files = [("elf", ("./elf", stack.enter_context(open("./elf", "rb")))), ("vmexe", ("./vmexe", stack.enter_context(open("./vmexe", "rb"))))]
files += []
response = requests.request("POST", url, headers=headers, files=files)
print(response.text)// Node.js 22+
import { openAsBlob } from 'node:fs';
const form = new FormData();
form.append("elf", await openAsBlob("./elf"), "./elf");
form.append("vmexe", await openAsBlob("./vmexe"), "./vmexe");
const response = await fetch("https://api.axiom.xyz/v1/programs?default_num_gpus=8", {
method: "POST",
headers: {
"Axiom-API-Key": "<api-key>"
},
body: form
});
console.log(await response.text());<?php
$boundary = bin2hex(random_bytes(16));
$body = '';
$body .= "--" . $boundary . "\r\nContent-Disposition: form-data; name=\"" . 'elf' . "\"; filename=\"" . './elf' . "\"\r\nContent-Type: application/octet-stream" . "\r\n\r\n";
$body .= file_get_contents('./elf') . "\r\n";
$body .= "--" . $boundary . "\r\nContent-Disposition: form-data; name=\"" . 'vmexe' . "\"; filename=\"" . './vmexe' . "\"\r\nContent-Type: application/octet-stream" . "\r\n\r\n";
$body .= file_get_contents('./vmexe') . "\r\n";
$body .= "--" . $boundary . "--\r\n";
$curl = curl_init('https://api.axiom.xyz/v1/programs?default_num_gpus=8');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POSTFIELDS => $body,
CURLOPT_HTTPHEADER => ['Axiom-API-Key: <api-key>', 'Content-Type: multipart/form-data; boundary=' . $boundary],
]);
$response = curl_exec($curl);
if ($response === false) { throw new RuntimeException(curl_error($curl)); }
curl_close($curl);
echo $response;package main
import (
"bytes"
"fmt"
"io"
"mime/multipart"
"net/http"
"os"
"path/filepath"
)
func main() {
var body bytes.Buffer
writer := multipart.NewWriter(&body)
file0, err := os.Open("./elf")
if err != nil { panic(err) }
part0, err := writer.CreateFormFile("elf", filepath.Base(file0.Name()))
if err != nil { panic(err) }
if _, err = io.Copy(part0, file0); err != nil { panic(err) }
file0.Close()
file1, err := os.Open("./vmexe")
if err != nil { panic(err) }
part1, err := writer.CreateFormFile("vmexe", filepath.Base(file1.Name()))
if err != nil { panic(err) }
if _, err = io.Copy(part1, file1); err != nil { panic(err) }
file1.Close()
if err := writer.Close(); err != nil { panic(err) }
req, err := http.NewRequest("POST", "https://api.axiom.xyz/v1/programs?default_num_gpus=8", &body)
if err != nil { panic(err) }
req.Header.Set("Content-Type", writer.FormDataContentType())
req.Header.Set("Axiom-API-Key", "<api-key>")
res, err := http.DefaultClient.Do(req)
if err != nil { panic(err) }
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil { panic(err) }
fmt.Println(string(data))
}HttpResponse<String> response = Unirest.post("https://api.axiom.xyz/v1/programs?default_num_gpus=8")
.header("Axiom-API-Key", "<api-key>")
.field("elf", new java.io.File("./elf"))
.field("vmexe", new java.io.File("./vmexe"))
.asString();require 'uri'
require 'net/http'
url = URI("https://api.axiom.xyz/v1/programs?default_num_gpus=8")
request = Net::HTTP::Post.new(url)
request["Axiom-API-Key"] = "<api-key>"
files = []
begin
form = [
["elf", (files << File.open("./elf", 'rb')).last],
["vmexe", (files << File.open("./vmexe", 'rb')).last]
]
request.set_form(form, 'multipart/form-data')
response = Net::HTTP.start(url.host, url.port, use_ssl: url.scheme == 'https') { |http| http.request(request) }
puts response.body
ensure
files.each(&:close)
end{
"id": "<string>"
}{
"id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Register new program
Register a new OpenVM program from pre-built artifacts.
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"curl --request POST \
--url 'https://api.axiom.xyz/v1/programs?default_num_gpus=8' \
--header 'Axiom-API-Key: <api-key>' \
--header 'Content-Type: multipart/form-data' \
--form elf=@example-file \
--form vmexe=@example-filefrom contextlib import ExitStack
import json
import requests
url = "https://api.axiom.xyz/v1/programs?default_num_gpus=8"
headers = json.loads("{\"Axiom-API-Key\":\"<api-key>\"}")
with ExitStack() as stack:
files = [("elf", ("./elf", stack.enter_context(open("./elf", "rb")))), ("vmexe", ("./vmexe", stack.enter_context(open("./vmexe", "rb"))))]
files += []
response = requests.request("POST", url, headers=headers, files=files)
print(response.text)// Node.js 22+
import { openAsBlob } from 'node:fs';
const form = new FormData();
form.append("elf", await openAsBlob("./elf"), "./elf");
form.append("vmexe", await openAsBlob("./vmexe"), "./vmexe");
const response = await fetch("https://api.axiom.xyz/v1/programs?default_num_gpus=8", {
method: "POST",
headers: {
"Axiom-API-Key": "<api-key>"
},
body: form
});
console.log(await response.text());<?php
$boundary = bin2hex(random_bytes(16));
$body = '';
$body .= "--" . $boundary . "\r\nContent-Disposition: form-data; name=\"" . 'elf' . "\"; filename=\"" . './elf' . "\"\r\nContent-Type: application/octet-stream" . "\r\n\r\n";
$body .= file_get_contents('./elf') . "\r\n";
$body .= "--" . $boundary . "\r\nContent-Disposition: form-data; name=\"" . 'vmexe' . "\"; filename=\"" . './vmexe' . "\"\r\nContent-Type: application/octet-stream" . "\r\n\r\n";
$body .= file_get_contents('./vmexe') . "\r\n";
$body .= "--" . $boundary . "--\r\n";
$curl = curl_init('https://api.axiom.xyz/v1/programs?default_num_gpus=8');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POSTFIELDS => $body,
CURLOPT_HTTPHEADER => ['Axiom-API-Key: <api-key>', 'Content-Type: multipart/form-data; boundary=' . $boundary],
]);
$response = curl_exec($curl);
if ($response === false) { throw new RuntimeException(curl_error($curl)); }
curl_close($curl);
echo $response;package main
import (
"bytes"
"fmt"
"io"
"mime/multipart"
"net/http"
"os"
"path/filepath"
)
func main() {
var body bytes.Buffer
writer := multipart.NewWriter(&body)
file0, err := os.Open("./elf")
if err != nil { panic(err) }
part0, err := writer.CreateFormFile("elf", filepath.Base(file0.Name()))
if err != nil { panic(err) }
if _, err = io.Copy(part0, file0); err != nil { panic(err) }
file0.Close()
file1, err := os.Open("./vmexe")
if err != nil { panic(err) }
part1, err := writer.CreateFormFile("vmexe", filepath.Base(file1.Name()))
if err != nil { panic(err) }
if _, err = io.Copy(part1, file1); err != nil { panic(err) }
file1.Close()
if err := writer.Close(); err != nil { panic(err) }
req, err := http.NewRequest("POST", "https://api.axiom.xyz/v1/programs?default_num_gpus=8", &body)
if err != nil { panic(err) }
req.Header.Set("Content-Type", writer.FormDataContentType())
req.Header.Set("Axiom-API-Key", "<api-key>")
res, err := http.DefaultClient.Do(req)
if err != nil { panic(err) }
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil { panic(err) }
fmt.Println(string(data))
}HttpResponse<String> response = Unirest.post("https://api.axiom.xyz/v1/programs?default_num_gpus=8")
.header("Axiom-API-Key", "<api-key>")
.field("elf", new java.io.File("./elf"))
.field("vmexe", new java.io.File("./vmexe"))
.asString();require 'uri'
require 'net/http'
url = URI("https://api.axiom.xyz/v1/programs?default_num_gpus=8")
request = Net::HTTP::Post.new(url)
request["Axiom-API-Key"] = "<api-key>"
files = []
begin
form = [
["elf", (files << File.open("./elf", 'rb')).last],
["vmexe", (files << File.open("./vmexe", 'rb')).last]
]
request.set_form(form, 'multipart/form-data')
response = Net::HTTP.start(url.host, url.port, use_ssl: url.scheme == 'https') { |http| http.request(request) }
puts response.body
ensure
files.each(&:close)
end{
"id": "<string>"
}{
"id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Query Parameters
The ID of the config to use (format: cfg_{ulid})
Optional custom name for the program
If applicable, the commit sha of the guest program
The ID of the project to associate this program with. If not provided, a new project will be created.
Name for new project if project_id is not provided
Default number of GPUs to use for proofs of this program
1 <= x <= 10000Response
Successful Response
Program registered successfully
Invalid files or parameters
Not found
Files too large
Validation Error
Generic response for POST operations.
Generic response for POST operations.