API Reference

Get run logs

GET /api/runs/{id}/logs

Returns full log text for completed runs. For active runs, returns a Server-Sent Events stream with log events (line data) and a final done event with {"status": "..."}.

Operation IDgetRunLogs

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Query parameters

snapshotstring

If set, forces a snapshot (full text) response even for active runs.

tailinteger

Return only the last N bytes of the log. Applies when the response would be a snapshot (completed run or snapshot=true).

Minimum: 1
Maximum: 10000000

Success response body

200Log content (text/plain for completed, text/event-stream for active)

Log content (text/plain for completed, text/event-stream for active)

Content typetext/plain

responsestring

Content typetext/event-stream

responsestring

Error responses

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/runs/YOUR_ID/logs?snapshot=YOUR_SNAPSHOT&tail=YOUR_TAIL' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/runs/YOUR_ID/logs?snapshot=YOUR_SNAPSHOT&tail=YOUR_TAIL", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);