Skip to main content
API Reference

Get Usage Summary

Retrieve the current account credit balance and resource overview.

GET/api/open/v1/usage

Endpoint Overview

200usage:read

Retrieve the current account credit balance and resource overview.

Authentication

Use this request header: Authorization: Bearer <token>
Required scopes for this endpoint:usage:read

Response

200 - application/json
object
string

固定为 usage.summary。

credits
object

Current available credits.

available
number

Available credits.

expires_at
string | null

Subscription credit expiration time.

updated_at
string | null

最近Updated time.

resources
object

Resource counts associated with the current account.

community_discovery_jobs
number

Community Discovery job count.

community_overview_jobs
number

Community Overview job count.

monitoring_jobs
number

Monitoring job count.

active_api_keys
number

Active API key count.

Common Errors

UNAUTHORIZED
error_code

Missing or invalid Bearer token.

FORBIDDEN
error_code

The current token is missing the required scope.

RATE_LIMITED
error_code

The current token hit a rate limit.

INVALID_ARGUMENT
error_code

Request parameters do not satisfy the schema constraints.

NOT_FOUND
error_code

The target resource does not exist or does not belong to the current account.

Search API Docs

Full-text search across pages, sections, endpoints, and fields

Agent entry

If you are an agent, do not look for a separate manual first. RedditFind now keeps one shortest discovery index, one routing contract, and one API contract.

Use llms-index.txt to discover the stack quickly, agent-overview.json to route the job, and the OpenAPI spec when the workflow needs authenticated programmatic access.

Public demos still matter, but only for validating result shapes after the contracts are clear.

Why this stack is stronger now

  • Semantic detection layers Reddit discussions by demand, complaints, comparisons, and opportunities instead of relying on keywords alone.
  • The Reddit assistant connects discovery, analysis, monitoring, and next actions so agents do less manual orchestration.
  • With the Open API, agents can create jobs, read results, and plug RedditFind into their own workflows through a formal contract instead of guessing UI behavior.

Route by user objective

  • Community discovery Use when the user still does not know where demand, competitors, or relevant communities live. Open feature page
  • Subreddit analysis Use when target communities are already known and the user needs rules, tone, content patterns, and risks. Open feature page
  • Post monitoring Use when the user needs an ongoing queue of new opportunities, feedback signals, or high-intent threads. Open feature page
  • Reddit assistant Use when discovery, analysis, or monitoring context already exists and the user needs the next best action with lower execution risk. Open feature page

Core contracts and validation

Boundaries and non-goals

  • RedditFind does not auto-post to Reddit.
  • Human review is required before any public reply or post.
  • RedditFind does not support bulk direct-message automation.
  • It is not a generic web search engine or an autonomous posting bot that bypasses human oversight.
  • The Open API creates RedditFind jobs and reads results. It does not bypass human review for public Reddit engagement.