Rankhog Docs
DocsCLIMCPAPI
API Reference

Get Warm-up State

Return the workspace warm-up snapshot: active plan progress, today's work, per-account warming state, credit requirement, and account health. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

POST
/agent/v1/warmup/state

Return the workspace warm-up snapshot: active plan progress, today's work, per-account warming state, credit requirement, and account health. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Authorization

AuthorizationBearer <token>

Rankhog organization API key sent as Authorization: Bearer rhog_....

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/agent/v1/warmup/state" \  -H "Content-Type: application/json" \  -d '{    "managedRedditAccountId": "mra_2x9rnkhdemo",    "organizationId": "org_2x9rnkhdemo",    "websiteId": "site_2x9rnkhdemo"  }'
{  "activePlan": {    "activeSafetyIncident": null,    "dayIndex": 3,    "durationDays": 14,    "endsAt": "2026-06-30T09:00:00.000Z",    "id": "warmup_plan_2x9rnkhdemo",    "redditAccountId": "reddit_2x9rnkhdemo",    "startedAt": "2026-06-17T12:00:00.000Z",    "subreddits": [      {        "eligibilityStatus": "eligible",        "subreddit": "AskReddit"      },      {        "eligibilityStatus": "eligible",        "subreddit": "SaaS"      }    ],    "todayWork": {      "comments": 3,      "commentsReady": 2,      "commentsWaitingForSources": 1,      "findingAskReddit": false    },    "windowElapsed": false  },  "accounts": [    {      "commentKarma": 412,      "creditConsumed": true,      "isPrimary": true,      "metricsFresh": true,      "recommendedDurationDays": 14,      "redditAccountId": "reddit_2x9rnkhdemo",      "redditUsername": "rankhog_demo",      "resumableDays": 0,      "totalKarma": 1830,      "warming": true    }  ],  "credits": {    "available": 212,    "cost": 50,    "spendable": 208  },  "health": {    "accountAgeDays": 245,    "capturedAt": "2026-06-17T12:00:00.000Z",    "commentKarma": 412,    "healthStatus": "healthy",    "karmaDelta7d": 36,    "posture": "standard",    "reasons": [],    "score": 82,    "totalKarma": 1830  }}
{  "error": {    "code": "agentic_invalid_input",    "details": {      "issues": [        {          "code": "invalid_type",          "message": "Expected string, received undefined.",          "path": [            "organizationId"          ]        }      ]    },    "message": "Request body did not match the agentic capability schema."  }}

{  "error": {    "code": "agentic_unauthorized",    "message": "Authenticate before using Rankhog agentic capabilities."  }}

{  "error": {    "code": "agentic_paid_plan_required",    "details": {      "managedAccountBillingStatus": "active",      "subscriptionStatus": "past_due"    },    "message": "Rankhog agentic capabilities are available only for active or trialing paid workspaces."  }}

{  "error": {    "code": "agentic_missing_scope",    "details": {      "missingScopes": [        "rankhog:read"      ]    },    "message": "Missing required OAuth scope: rankhog:read."  }}

{  "error": {    "code": "agentic_managed_account_not_found",    "message": "Managed Reddit account not found."  }}
{  "error": {    "code": "agentic_internal_error",    "message": "Rankhog could not complete this agentic request."  }}

Update Opportunity Draft POST

Edit one opportunity's linked Reddit draft. The audited mode queues the edit through the safety audit; direct saves immediately. Edit attribution requires a human-authenticated actor. Cache policy: live. Idempotency: none. Auth modes: mcp_oauth, session_bearer.

Get Reddit Account Protection POST

Return the protection policy and pacing risk that gate Reddit writes for one workspace account, so a blocked execution can be predicted instead of discovered. Changing the policy stays human-only. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.