Recommend a card

/v1/discovery/recommend

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

No live response has been captured for this route yet (TI-57); the response tab shows an example generated from the schema.

Authorizations

Authorizationstringheaderrequired

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

Body

application/json

typestringrequired

taskstringrequired

Response

Recommendation

application/json

recommendedstring

cardCard · object

Registry capability card (summary fields).

Show child attributes

idstringrequired

namestringrequired

typestringrequired

categorystringrequired

statusstringrequired

descriptionstring

tagsstring[]

qualityobject | null

Present only when the search was called with include=quality; null when unmeasured (no eval-service binding on this tier, no runs yet, or an upstream miss).

Show child attributes

scorenumber | null

success_ratenumber | null

runsinteger

scorenumber

invalid_json / invalid_request — malformed or rejected body

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

Missing, invalid, expired or revoked ozk_ key.

Error code: unauthorizedfrom code

rate_limited — Retry-After header

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

import os import requests response = requests.post( "https://api.plungeai.com/v1/discovery/recommend", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, json={ "type": "agent", "task": "search the web for recent news", }, ) 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/discovery/recommend', { method: 'POST', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ "type": "agent", "task": "search the web for recent news" }), }) 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/discovery/recommend")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString("{\"type\":\"agent\",\"task\":\"search the web for recent news\"}")) .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()); } }

curl -X POST 'https://api.plungeai.com/v1/discovery/recommend' \ -H "Authorization: Bearer $PLUNGE_API_KEY" \ -H 'Content-Type: application/json' \ -d '{"type":"agent","task":"search the web for recent news"}'

{ "recommended": "<string>", "card": { "id": "<string>", "name": "<string>", "type": "<string>", "category": "<string>", "status": "<string>", "description": "<string>", "tags": [ "<string>" ], "quality": { "score": 0, "success_rate": 0, "runs": 0 } }, "score": 0 }

Authorizations

Body

Response

Planned: TI-33

Planned: TI-34