Skip to main content
GET
List the opportunities Content Agent found

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Query Parameters

state
enum<string>
Available options:
proposed,
cooldown,
no_action,
dismissed,
promoted,
expired
intervention
enum<string>
Available options:
create_article,
update_existing_article,
metadata,
faq_or_schema,
internal_links,
no_action
limit
integer
default:25
Required range: 1 <= x <= 50

Response

Ranked opportunities

data
object[]
required
meta
object
required