API Reference

API Reference

Generated endpoint reference for the Rankhog agentic REST API.

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 cached subreddit activity and optionally refresh it through the paired Rankhog Desktop browser. 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 Plan

Return the current Rankhog strategy plan for a paid workspace. Cache policy: cached. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Get Workspace Strategy Activity

Return recent Rankhog strategy activity for a paid workspace. Cache policy: cached. 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.

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 approved 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.

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.

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.