API Reference

Get Agentic Actor

Return the authenticated Rankhog agentic actor, source, organization, and granted scopes. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

List Agentic Workspaces

List paid Rankhog workspaces and identifiers available to the authenticated actor. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Get Subreddit Rules

Fetch verified or live Reddit subreddit rules for a paid Rankhog workspace. Cache policy: cached. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Get Subreddit Activity

Return subreddit activity from the durable Reactive source without bypassing internal collector scheduling. Cache policy: cached. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Get Reddit Browser Status

Report whether Rankhog Desktop has a ready Reddit browser session for this managed account. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Open Reddit URL

Open an allowed Reddit URL in the paired Rankhog Desktop browser. This never exposes raw browser control. Cache policy: live. Idempotency: required. Auth modes: mcp_oauth, session_bearer.

Get Workspace Strategy

Return the current product-owned Discovery and Radar strategy. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Get Radar Coverage

Return current Radar watcher coverage and collector health. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Report whether Radar is running for this workspace, what is blocking it, and what it has checked, surfaced and triaged recently. Cache policy: cached. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Start Discovery

Start Discovery with an optional product direction. Cache policy: live. Idempotency: required. Auth modes: mcp_oauth, session_bearer.

Stop Discovery

Stop Discovery without changing Radar. Cache policy: live. Idempotency: required. Auth modes: mcp_oauth, session_bearer.

Run Discovery Now

Run the active Discovery session now, subject to its hourly limit. Cache policy: live. Idempotency: required. Auth modes: mcp_oauth, session_bearer.

Set Radar Enabled

Enable or disable Radar without changing Discovery. Cache policy: live. Idempotency: required. Auth modes: mcp_oauth, session_bearer.

Update Strategy Inputs

Replace shared strategy keywords and watched Radar communities. A community Rankhog has a guide for starts watching immediately; any other is saved but stays inactive until a guide exists for it. Cache policy: live. Idempotency: required. Auth modes: mcp_oauth, session_bearer.

List Opportunities

List actionable Rankhog opportunities for a paid workspace, including timing, blockers, compact evidence, and linked execution state. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Get Opportunity

Return one Rankhog opportunity with public-safe evidence, blocker remediation, timing, outcome, and linked action summary. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Get Planned Reddit Action

Return one planned Reddit action from a paid workspace. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Get Opportunity Conversation

Read one opportunity's conversation timeline: milestones, drafts, questions, and messages. Poll with afterSeq for new items. Every current opportunity has a conversation; preserved legacy history can return a null conversationId when no old thread exists. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Post Opportunity Conversation Message

Post a plain text message into a current opportunity conversation and queue an agent turn. Completed, dismissed, expired, and cutover-history conversations are read-only. API keys are automation actors: their messages can steer and ask, but Reddit-write confirmations stay human-only. Cache policy: live. Idempotency: required. Auth modes: api_key, mcp_oauth, session_bearer.

Create Reddit Post Draft

Create a ready manual Reddit post draft after fetching subreddit rules. Cache policy: live. Idempotency: required. Auth modes: api_key, mcp_oauth, session_bearer.

Create Reddit Action

Create a stored Reddit write action for post, comment, reply, upvote, or join_subreddit. Draft approval and write execution remain separate. Cache policy: live. Idempotency: required. Auth modes: api_key, mcp_oauth, session_bearer.

Approve Reddit Draft

Deprecated legacy approval for future publishing flows. Normal drafts are ready manual actions. Cache policy: live. Idempotency: required. Auth modes: mcp_oauth, session_bearer.

Execute Reddit Action

Queue an authorized Reddit write action for Desktop execution and return a stable execution ID immediately. Duplicate idempotent triggers reuse the existing execution. Cache policy: live. Idempotency: required. Auth modes: api_key, mcp_oauth, session_bearer.

Get Reddit Action Execution Status

Return normalized status for a Reddit action execution, including workflow step, final Reddit permalink, and structured failure or verification-required details. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

List Reddit Action History

List and filter the immutable Reddit action execution ledger, including creation origin and aggregate community support, for one paid Rankhog workspace. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Get Reddit Action History

Inspect one tenant-scoped Reddit action receipt with immutable origin, aggregate community support, lifecycle events, observations, and derived performance. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Get Control Pane Analytics Summary

Return the cached Rankhog control-pane analytics summary for a paid workspace. Cache policy: cached. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Get Job

Return one authorized background job snapshot. API keys cannot use this endpoint. Cache policy: live. Idempotency: none. Auth modes: mcp_oauth, session_bearer.

List Planned Jobs

List planned Rankhog jobs for an organization the actor can access. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Get Credit Balance

Return the credit balance for an organization, or for one product when websiteId is set: period credits, organization bank, committed and spendable amounts, per-product balances, and the current cost table. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

List Credit Ledger

Page through the organization credit ledger, newest first: grants, purchases, refunds, adjustments, and every debit with its actor kind and the action, warm-up, purchase, or opportunity it paid for. Member names and user ids are never included. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Legacy Dangerous Reddit Post Submit

Legacy compatibility path for Desktop-backed Reddit post submit. Prefer execute_reddit_action for new clients. Requires OAuth with reddit:write:dangerous. Cache policy: live. Idempotency: required. Auth modes: mcp_oauth.