List agents

/v1/agents

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.

The response also carries limit, offset, has_more and next_offset (null on the last page).

Authorizations

Authorizationstringheaderrequired

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

Query parameters

limitinteger

Default: 50

Required range: x <= 100

offsetinteger

Default: 0

Response

Active agent list

application/json

agentsCard[]

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

countinteger

Missing, invalid, expired or revoked ozk_ key.

Error code: unauthorizedfrom code

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

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

Authorizations

Query parameters

Response

Planned: TI-33

Planned: TI-34