Agency

Get the Agency workspace

Workspace identity, the caller's role, remaining shared project quota, and one page of the workspace's client reports - dashboard-created ones included, newest first, without report bodies. Consultant and AppSumo Agency accounts only: a key whose account holds no Agency workspace, or whose membership was removed, gets 404 AGENCY_NOT_FOUND on the next call. Membership is resolved live on every request, independently of the key.

get/api/agent/agency

Request

  • Base URL: https://preuve.ai
  • URL: https://preuve.ai/api/agent/agency
  • Auth: API key in header x-preuve-key

Query parameters

limitinteger

Client reports to return in the reports array.

offsetinteger

Paging offset into the reports array.

Response

Workspace, role, quota, and one page of client reports.

canRunScanboolean

Eligibility, not live availability. True only when the role may run scans, the workspace is approved, billing setup is done, and quota remains. It does not read the service kill switch, the LLM pause or the rate limiters, so a start can still answer 503 or 429 while this is true. None of those refusals spends a project credit.

nextOffsetinteger nullable

Offset of the next page of reports, or null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.