Get an execution

/v1/executions/{id}

status is the run’s state; a run that finished its turn and waits on the user reads needs_input (a question) or needs_approval (a held action) with the continuation — answer it with POST …/continue.

Authorizations

Authorizationstringheaderrequired

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

Path parameters

idstringrequired

Execution id (the x-execution-id of the run, or its engine id exec-…)

Query parameters

formatenum<string>

Response format; overrides Accept (an unknown value is 400 invalid_format)

Available options: json, yaml, markdown, text

on_behalf_ofstring

Read a run that was made on a customer’s behalf (POST /v1/execute with on_behalf_of): its output sits under <your account>:cust:<id>. 1-128 characters of A-Z a-z 0-9 _ . - (no ".."); a bad value is 400 invalid_on_behalf_of. The run itself must still be yours. Honoured by the status, output and files reads only: continue, followup, steer, stream and conversation look under your own tenant.

Minimum string length: 1 Maximum string length: 128

Response

Execution status Response format negotiates via the format field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON.

application/json
text/yaml
text/markdown
text/plain

execution_idstring

statusstring

running | completed | incomplete | failed | cancelled, or needs_input / needs_approval when the run finished its turn and waits for the user (POST …/continue)

error_messagestring | null

workflow_namestring | null

started_atstring | null

duration_msinteger | null

final_task_idstring | null

continuationobject | null

Non-null when the run is paused awaiting the user

Show child attributes

statusenum<string>

Available options: question, needs_approval

agentstring

questionstring | null

pending_actionobject | null

The held action: summary, price, and the permission class / tool when known

invalid_on_behalf_of — not a valid customer id

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

unauthorized — missing, invalid or revoked ozk_ key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

execution_not_found — no execution with that id for this key (a foreign id answers the same); not_found — no route for this method on this path: every other method answers it

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

upstream_error — a store failed; no detail is returned, retry shortly

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

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

const response = await fetch('https://api.plungeai.com/v1/executions/{id}', { method: 'GET', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, }, }) if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`) console.log(await response.json())

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/executions/{id}")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .GET() .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()); } }

{ "execution_id": "<string>", "status": "<string>", "error_message": "<string>", "workflow_name": "<string>", "started_at": "<string>", "duration_ms": 0, "final_task_id": "<string>", "continuation": { "status": "question", "agent": "<string>", "question": "<string>", "pending_action": {} } }

Authorizations

Path parameters

Query parameters

Response

Planned: TI-33

Planned: TI-34