Get a tool contract

/v1/tools/{id}

Headers: every response carries x-request-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

Response

The contract

application/json

agent_idstringrequired

credentialCredential · object

The credential an agent runs on. platform: our keys, nothing to set up. connection: the caller’s own account at provider — connect it once with POST /v1/connections/{provider} (a key) or POST /v1/connections/{provider}/link (a hosted link); without it a call answers 424 with a connect pointer.

tierenum<string>required

Available options: platform

tierenum<string>required

Available options: connection

providerstringrequired

methodenum<string>required

Available options: oauth, api_key, wallet

namestringrequired

descriptionstringrequired

operationsobject[]required

Show child attributes

namestringrequired

purposestring

gatedbooleanrequired

required_paramsstring[]

inputSchemaobjectrequired

examplesobject[]required

Show child attributes

titlestringrequired

cnlstringrequired

output_typestring

unauthorized — missing, invalid or revoked ozk_ key

Error code: unauthorizedfrom code

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"

unknown_tool; 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"

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

{ "agent_id": "<string>", "credential": { "tier": "platform" }, "name": "<string>", "description": "<string>", "operations": [ { "name": "<string>", "purpose": "<string>", "gated": true, "required_params": [ "<string>" ] } ], "inputSchema": {}, "examples": [ { "title": "<string>", "cnl": "<string>" } ], "output_type": "<string>" }