Stream a saved workflow

/v1/workflows/{id}/execute-stream

Send the optional body as application/json (input, inputs).

Headers: every response carries x-request-id (quote it in support requests). Send x-trace-id (optional, a UUID) to correlate this call across planes; reusing an id that already ran answers 409 duplicate_execution_id. Pick the body format with format or Accept (application/json, text/yaml, text/markdown, text/plain).

Authorization: send Authorization: Bearer $PLUNGE_API_KEY; X-API-Key: <ozk_ key> is accepted as an alternative.

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Path parameters

idstringrequired

Body

application/json

inputstring

inputsobject

Response

SSE stream: request_received, workflow_loaded, workflow_started, task_dispatched, streaming_started (streaming agents), token (one frame per provider delta: {"task_id","delta"}), heartbeat, task_completed, workflow_completed (carries execution_summary), workflow_result. Single connection: the gateway drains the provider stream itself; terminal events always arrive on this SSE.

text/event-stream

Missing, invalid, expired or revoked ozk_ key.

Error code: unauthorizedfrom code

payload_too_large — body over 1 MiB (MAX_REQUEST_SIZE)

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

rate_limited — Retry-After header

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

Stream events

Event	Description
`task_completed`	A task finished.
`heartbeat`	While a task runs longer than 20 s, about every 25 s.
`workflow_completed`	Terminal event on success.
`workflow_error`	Terminal event on failure.

event: task_completed
data: {"task_id":"t1"}

event: heartbeat
data: {}

event: workflow_completed
data: {"final_task_id":"t1"}

event: workflow_error
data: {"error":"…"}

import os import requests response = requests.post( "https://api.plungeai.com/v1/workflows/{id}/execute-stream", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, json={}, ) if not response.ok: raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}") print(response.json())

import os import requests with requests.post( "https://api.plungeai.com/v1/workflows/{id}/execute-stream", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, json={}, stream=True, ) as response: if not response.ok: raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}") for line in response.iter_lines(): if line == b"data: [DONE]": break if line: print(line.decode())

const response = await fetch('https://api.plungeai.com/v1/workflows/{id}/execute-stream', { method: 'POST', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({}), }) if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`) const reader = response.body!.getReader() const decoder = new TextDecoder() let buffer = '' read: while (true) { const { done, value } = await reader.read() if (done) break buffer += decoder.decode(value, { stream: true }) const frames = buffer.split('\n\n') buffer = frames.pop() ?? '' for (const frame of frames) { if (frame.trim() === 'data: [DONE]') break read console.log(frame) } }

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.plungeai.com/v1/workflows/{id}/execute-stream")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString("{}")) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() >= 400) { System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse("")); return; } System.out.println(response.body()); } }

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.plungeai.com/v1/workflows/{id}/execute-stream")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString("{}")) .build(); HttpResponse<java.util.stream.Stream<String>> response = client.send(request, HttpResponse.BodyHandlers.ofLines()); if (response.statusCode() >= 400) { System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse("")); return; } response.body().takeWhile(line -> !line.equals("data: [DONE]")).forEach(System.out::println); } }

Stream a saved workflow

Authorizations

Path parameters

Body

Response

Stream events

Planned: TI-33

Planned: TI-34