API Reference

Get opportunity evidence

Read bounded opportunity product knowledge, source evidence, community rules, or conversation history. Targets are scoped to the opportunity.

POST
/agent/v1/opportunities/evidence

Read bounded opportunity product knowledge, source evidence, community rules, or conversation history. Targets are scoped to the opportunity. Uses cached rules and normal thread caching, never forced refresh. Community reads additionally require reddit:rules:read. Continue text with nextOffset; reset offset when following nextBeforeSeq. 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/opportunities/evidence" \  -H "Content-Type: application/json" \  -d '{    "organizationId": "org_example",    "websiteId": "site_example",    "opportunityId": "opp_example",    "section": "product"  }'
{  "section": "product",  "status": "available",  "provenance": "saved product knowledge",  "text": "Name: SupportLeaf",  "truncated": false,  "nextOffset": null,  "nextBeforeSeq": 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_paid_plan_required",    "details": {      "managedAccountBillingStatus": "active",      "productId": "site_demo",      "subscriptionStatus": "past_due"    },    "message": "This product has no active plan or trial yet. Call get_product_setup with productId site_demo: it gives the link where the person starts the 7-day trial. Never pay for them."  }}

{  "error": {    "code": "agentic_missing_scope",    "details": {      "missingScopes": [        "rankhog:read"      ]    },    "message": "Missing required 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."  }}