Rankhog Docs
DocsCLIMCPAPI
API Reference

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.

POST
/agent/v1/jobs/get

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

Authorization

AuthorizationBearer <token>

In: header

Scope: rankhog:read

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

curl -X POST "https://example.com/agent/v1/jobs/get" \  -H "Content-Type: application/json" \  -d '{    "jobId": "job_2x9rnkhdemo"  }'
{  "job": {    "attempt": 1,    "cancelledAt": null,    "createdAt": "2026-06-17T11:45:00.000Z",    "createdByUserId": "usr_2x9rnkhdemo",    "creationOrigin": "user",    "error": null,    "failedAt": null,    "finishedAt": null,    "heartbeatAt": null,    "id": "job_2x9rnkhdemo",    "lane": "browser-control",    "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,    "retryOrdinal": 0,    "retryRootJobId": null,    "runCount": 0,    "scheduledAt": "2026-06-17T11:45:00.000Z",    "startDeadlineAt": "2026-06-17T12:45:00.000Z",    "startedAt": null,    "state": {      "phase": "scheduled"    },    "status": "scheduled",    "type": "reddit.execute_planned_action",    "updatedAt": "2026-06-17T12:00:00.000Z",    "version": 1,    "websiteId": "site_2x9rnkhdemo"  },  "milestones": [    {      "createdAt": "2026-06-17T11:46:00.000Z",      "id": "milestone_2x9rnkhdemo",      "jobId": "job_2x9rnkhdemo",      "key": "desktop-ready",      "kind": "customer",      "message": "Rankhog Desktop is ready.",      "payload": null    }  ]}
{  "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_missing_scope",    "details": {      "missingScopes": [        "rankhog:read"      ]    },    "message": "Missing required OAuth scope: rankhog:read."  }}

{  "error": {    "code": "agentic_job_not_found",    "message": "Job not found."  }}
{  "error": {    "code": "agentic_internal_error",    "message": "Rankhog could not complete this agentic request."  }}

Get Control Pane Analytics Summary POST

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.

List Planned Jobs POST

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