Skip to main content

API Reference

Retrievy exposes two APIs.

APIUsed byAuthentication
Agent APIThe Retrievy Agent (Windows MSI and Docker container) to register, heartbeat, and ship scan snapshots back to your workspace.Bearer token + RSA proof-of-possession.
Public APIYour own automation: pull findings into a SIEM, push status updates from a ticketing system, export your Retrievy Index on a cadence.Bearer token.

Both APIs are versioned (/api/v1/...), rate-limited per workspace, and return JSON. Errors follow a standard { "error": { "code", "message", "details" } } shape.

What's on this page​

The Agent API and Public API references are auto-generated from OpenAPI specs. They land here as separate sub-sections once the OpenAPI plugin reaches the docs site (it's currently parked behind a dependency upgrade; the plugin's postman-code-generators dependency is being unpinned upstream).

In the meantime, if you need API access right now:

  • Public API: contact support to be enrolled in the early-access programme. You'll get a workspace token and a markdown reference of the available endpoints.
  • Agent API: not user-facing. The Retrievy Agent handles all calls automatically; you don't write code against it.