Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
API ReferenceComputePods

Get a pod's container log tail

Returns the tail of a pod's container output (startup, CUDA errors, a crash's last lines), capped to a bounded size, or found false while it starts.

Required permission

Requires the compute.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl pods log get <pod-id>
GET
/api/nomad/pods/{podId}/logs

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

podId*string

Response Body

OK

application/json
  1. response

A guest's console text, or a soft "not ready yet" status: a transient state (no allocation yet, logs temporarily unavailable) answers 200 with found false and a message, so a polling UI renders a state instead of an error toast; only ownership/existence failures are 404. Output is capped to a bounded tail (the same cap pods and VMs share), not the whole console.

found*boolean
content?string

The console's tail, when found is true.

message?string

Present when found is false (or on other soft states); human-readable.

Example Request
curl -X GET 'https://api.openrelay.inc/api/nomad/pods/string/logs'
Example Response
{  "found": true,  "content": "string",  "message": "string"}