Skip to main content

Documentation Index

Fetch the complete documentation index at: https://otoyinc.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Query Job Runs

After creating a Job, query for its Job Runs to get connection information:
GET /v1/job-runs?filter[job_uuid]={job_uuid}
Response:
{
  "data": [
    {
      "uuid": "run-uuid-here",
      "status": "ASSIGNED",
      "started_at_ms": 1705123456789,
      "node_urls": [
        {
          "description": "ssh",
          "hostname": "123.45.67.89",
          "port": 22,
          "protocol": "tcp"
        }
      ]
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 1
}

View Job Run Logs

The list endpoint (GET /v1/job-runs) does not include logs to keep responses small. To retrieve logs via the API, request a specific Job Run:
GET /v1/job-runs/{job_run_uuid}
The response includes the logs field with container output.
You can always view Job Run logs in the Dispersed Console on the Job Run Detail page.

Job Lifecycle

PENDING → ASSIGNED → RUNNING → COMPLETED
       ↘           ↘
    CANCELLED     FAILED
StatusDescription
PENDINGWaiting for node assignment
ASSIGNEDNode selected, container starting
RUNNINGContainer executing
COMPLETEDFinished successfully
FAILEDError occurred
CANCELLEDCancelled by user
CANCELLINGCancel requested