API Reference

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.

POST
/agent/v1/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.

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/strategy/plan" \  -H "Content-Type: application/json" \  -d '{    "managedRedditAccountId": "mra_2x9rnkhdemo",    "organizationId": "org_2x9rnkhdemo",    "websiteId": "site_2x9rnkhdemo"  }'
{  "billingMilestone": null,  "jobs": [    {      "attempt": 1,      "cancelledAt": null,      "createdAt": "2026-06-17T11:45:00.000Z",      "createdByUserId": "usr_2x9rnkhdemo",      "error": null,      "failedAt": null,      "finishedAt": null,      "heartbeatAt": null,      "id": "job_2x9rnkhdemo",      "managedRedditAccountId": "mra_2x9rnkhdemo",      "maxAttempts": 3,      "metadata": {        "source": "agentic_draft_approval"      },      "organizationId": "org_2x9rnkhdemo",      "parentJobId": null,      "progress": {        "message": "Waiting for Rankhog Desktop.",        "percent": 25      },      "publicInput": {        "plannedRedditActionId": "act_2x9rnkhdemo"      },      "result": null,      "scheduledAt": "2026-06-17T11:45:00.000Z",      "startedAt": null,      "state": {        "phase": "queued"      },      "status": "queued",      "type": "reddit.execute_planned_action",      "updatedAt": "2026-06-17T12:00:00.000Z",      "version": 1,      "websiteId": "site_2x9rnkhdemo"    }  ],  "memory": {    "positioning": "AI support widget for React SaaS teams."  },  "pendingReview": null,  "plan": {    "controls": {      "cadence": "weekly"    },    "executionState": {      "currentWeek": 3    },    "guardrails": [      {        "label": "No direct promotion without context"      }    ],    "isPaused": false,    "keywords": [      {        "query": "intercom alternative for react app"      }    ],    "plannedActions": [      {        "id": "act_2x9planned",        "subreddit": "SaaS",        "type": "post"      }    ],    "plays": [      {        "name": "Answer comparison threads"      }    ],    "proofEvents": [      {        "label": "Draft created",        "occurredAt": "2026-06-17T12:00:00.000Z"      }    ],    "researchSuggestions": [      {        "subreddit": "SaaS",        "topic": "activation"      }    ],    "strategy": {      "objective": "Build useful visibility in Reddit buyer threads."    },    "strategyStatusLine": "Ready for this week's planned Reddit work.",    "strategyVersion": {      "id": "sv_2x9rnkhdemo"    },    "subredditTargets": [      {        "name": "SaaS",        "priority": "high"      }    ]  }}
{  "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."  }}