Follow up

/v1/executions/{id}/followup

A run still in flight takes the message at its next turn (202 queued); a finished run continues its conversation (its agent session, else a researcher with the prior result as context) and answers 200.

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-…)

Body

application/json
text/yaml

textstringrequired

The message

Maximum string length: 65536

formatenum<string>

Available options: json, yaml, markdown, text

Response

The agent’s reply 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)

contentstring

The agent's reply

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

conversation_recordedboolean

false when the turn ran but could not be saved to the thread (GET …/conversation lacks it); the reply is still returned

Queued for the live run

application/json

execution_idstring

queuedboolean

missing_text — body needs a non-empty text; invalid_format / invalid_json / invalid_yaml — unreadable body or unknown format

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"

followup_failed — no answer; retry; 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.post( "https://api.plungeai.com/v1/executions/{id}/followup", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, json={ "text": "<string>", }, ) 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}/followup', { method: 'POST', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ "text": "<string>" }), }) 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}/followup")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString("{\"text\":\"<string>\"}")) .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>", "content": "<string>", "continuation": { "status": "question", "agent": "<string>", "question": "<string>", "pending_action": {} }, "conversation_recorded": true }

Authorizations

Path parameters

Body

Response

Planned: TI-33

Planned: TI-34