Execute a tool

/v1/tools/{id}/execute

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.

The response also carries execution_id. The request may be sent as text/yaml instead of JSON.

Authorizations

Authorizationstringheaderrequired

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

Path parameters

idstringrequired

Body

application/json

operationstring

Operation name from the contract

paramsobject

Operation params per the contract inputSchema

promptstring

Free-text prompt for prompt-driven agents

formatenum<string>

Response format override (precedence: this field → Accept header → mirror of the request Content-Type). Default json. yaml = the envelope with Markdown as block scalars; markdown = the same result the MCP plane renders; text = the bare result content. An unknown value → 400 invalid_format.

Available options: json, yaml, markdown, text

Response

Execution result 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

Response headers

x-request-idstringfrom code

Server-minted request id.

X-Execution-Idstringfrom code

The execution this call opened.

okbooleanrequired

contentstringrequired

outcomestring

request_idstring

invalid_format — format must be one of json, yaml, markdown, text

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

Missing, invalid, expired or revoked ozk_ key.

Error code: unauthorizedfrom code

refused — fence/gated operation

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

unknown_tool

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

approval_required — needs a human approval surface; duplicate_execution_id — x-trace-id already used by an earlier run

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

payload_too_large — body over 1 MiB (MAX_REQUEST_SIZE)

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

invalid_params — needs_input; body carries missing/reserved + the contract

Error code: invalid_paramsfrom code

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connection_required / credential_required — agent needs a connection or key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

rate_limited — Retry-After header

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

execution_failed

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

agent_unavailable — agent temporarily down

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

import os import requests response = requests.post( "https://api.plungeai.com/v1/tools/{id}/execute", 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())

const response = await fetch('https://api.plungeai.com/v1/tools/{id}/execute', { 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')}`) 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/tools/{id}/execute")) .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()); } }

{ "ok": true, "content": "# Result\n\nThree matching items found.", "outcome": "ok", "execution_id": "00000000-0000-4000-8000-000000000003", "request_id": "00000000-0000-4000-8000-000000000004" }

Authorizations

Path parameters

Body

Response

Response headers

Planned: TI-33

Planned: TI-34