List BYO review-agent links (console plane)

GET

/v1/admin/orgs/{org_id}/projects/{project_id}/review-links

• Production
• Local

The customer’s review links (D5). Secrets are elided (has_secret only). Console-only (Clerk-authed).

Authorizations

• ClerkSession

Parameters

Path Parameters

org_id

required

string

project_id

required

string

Responses

200

Ok

object

review_links

required

Array<object>

A BYO review-agent link (rvl_…); the subscription that routes a reviewed draft to a linked review-agent (D5; §9). One link per scope: inbox_address set = that inbox, empty = account-wide (per-inbox overrides account-wide). The reviewer holds review:act, NEVER mailbox:send; on approve/edit the platform sends with the COMPOSER’s creds (credential boundary). hmac_secret is write-only; reads return has_secret only. Opaque ids only (D10).

object

id

required

Opaque review-link id (rvl_…).

string

inbox_address

Scope: a specific inbox; empty = account-wide.

string

reviewer_agent_id

required

The linked reviewer agent (agt_…).

string

transport

required

string

Allowed values: webhook sse websocket

webhook_url

Delivery URL (webhook transport only).

string

has_secret

required

Whether an hmac signing secret is configured (the secret itself is never echoed).

boolean

escalate_after_s

required

Seconds before the reviewer-liveness sweeper auto-escalates to the human (default 300).

integer

max_hops

required

Circuit breaker: max reviewer hand-backs before the next action is forced to the human (default 3).

integer

review_deadline_s

required

Circuit breaker: hard per-review deadline in seconds (default 86400).

integer

active

required

boolean

consec_failures

required

Consecutive delivery failures; an unhealthy link is skipped by routing until recovery.

integer

created_at

required

string format: date-time

updated_at

required

string format: date-time

401

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

403

Authenticated but lacking the required scope, or out of quota.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope