Run jobs on your own machine, or on a node that can.

Your machine, your jobs

A computer you pair runs only the jobs you start: placement matches its owner before anything else.

1. Pair itOn openvibe.bot/machines, copy the one-line install command and run it on the computer. It joins as a worker under your account.
2. Start a jobOpenVibe.Codes' "Run on your machine" sends a coding task there, or your own code submits one through the API.
3. Watch it runThe job's event stream shows each state change and the machine's output as it is written.
4. Keep the recordEvery job ends succeeded, failed, cancelled or expired, with its timings, its exit and the seconds it ran.

How a job runs

1. SubmitPOST the job to /api/v1/jobs with a project token holding run.job.submit: which artifact to run, its input and its limits. Run checks it against the job contract, stores it queued and answers at once.
2. PlaceRun reads the network's node offers for the job's class and chooses one its requirements allow. With no eligible node it waits, retrying every second, until its time to live runs out.
3. RunOpenVibe.Bot sends the job to the node over its device link and meters every wall-clock second it runs. The node's output comes back as it is written.
4. EndSucceeded, failed, cancelled or expired. An end state never changes, and the job, its timings, its exit and its metered seconds stay readable to the project.

Runtime classes

A job names the class of machine it needs. What each one is today:

What you get

The API

Jobs are created with a project token from OpenVibe.Services (run.job.submit; reading, listing, cancelling and streaming take run.job.read, run.job.list, run.job.cancel and run.job.stream). A job names its runtime class, an artifact a machine declares (a name and one exact version: the first sample declares the one the other two run), its input and its limits.

# On your paired machine (installed with --worker): a function is a command you declare.
# Its args arrive as one line of JSON on stdin, its stdout streams back, and fd 3 is its result.
sudo mkdir -p /opt/fn/hello && sudo tee /opt/fn/hello/run > /dev/null <<'EOF'
#!/bin/sh
read -r args
echo "hello from job $OPENVIBE_JOB_ID: $args"
printf '{"ok":true}' >&3
EOF
sudo chmod 755 /opt/fn/hello/run
# Add it to "worker" → "functions" in /etc/openvibe-node/config.json, then: sudo systemctl restart openvibe-node
#   {"name": "hello", "version": "1.0.0", "command": ["/opt/fn/hello/run"]}

const { createClient } = require('openvibe-sdk/core');
const { createRunClient } = require('openvibe-sdk/run');

const run = createRunClient(createClient({ tokenProvider: tokens })).forProject('prj_…');
const { job } = await run.jobs.submit({
    class: 'function', artifact: { name: 'hello', version: '1.0.0' }, args: { name: 'world' },
    limits: { wall_ms: 30000, cpu_ms: 30000, mem_bytes: 268435456 }, ttl_ms: 600000,
});
for await (const ev of run.jobs.events(job.id)) console.log(ev.type, ev.data);   // state changes and output, until it ends

curl -X POST https://openvibe.run/api/v1/jobs \
  -H "Authorization: Bearer $PROJECT_TOKEN" -H "Content-Type: application/json" \
  -d '{"class":"function","artifact":{"name":"hello","version":"1.0.0"},"args":{"name":"world"},
       "limits":{"wall_ms":30000,"cpu_ms":30000,"mem_bytes":268435456},"ttl_ms":600000}'

The job routes

Questions