> ## Documentation Index > Fetch the complete documentation index at: https://docs.reechee.io/llms.txt > Use this file to discover all available pages before exploring further. # Reveal the reviewer (5 credits) > Reveal who wrote the review behind an opportunity: the reviewer's name, title and LinkedIn, their company, the full review and its source link. On Pay as you go these stay hidden on `GET /opportunities` and `GET /opportunities/{id}` until the reveal. **Spends 5 credits** on Pay as you go (1 credit on plans from before pay-as-you-go pricing, where it reveals the reviewer's LinkedIn). Idempotent: an opportunity already revealed returns the same data with `credits_used: 0` and no charge. Not available for mention-sourced opportunities (`400`), whose author is public. Requires a **spend budget** on the credential (per-key spend cap, or an OAuth connection's consent-time credit budget). When the team is out of credits the `402` carries `details.top_up_url`, the page where you buy a credit pack. ## OpenAPI ````yaml /openapi.yaml post /opportunities/{id}/reveal openapi: 3.1.0 info: title: Reechee Developer Platform API version: 1.0.0 description: > The Reechee REST API exposes software-review pain points, buying signals, and sales opportunities. Every operation except `GET /health` needs a credential, sent as `Authorization: Bearer …`. Two access lanes share one base URL: - **API Key** (`Authorization: Bearer rch_live_…`) - available on every plan, starting with pay-as-you-go: full pain-point reports, opportunities, watchlist, credit balance, safe write actions (follow/unfollow, triage), and credit-spending reveals. - **Connected** (an OAuth access token from the MCP Connect flow) - accepted in the same header as an API key. A call without a credential gets `401 unauthorized`, with a message pointing to sign up (start free, no card needed). Every response uses a consistent envelope: `{ "success": true, "data": … }` on success (with an optional `meta`), or `{ "success": false, "error": { "code", "message", "details"? } }` on failure. contact: name: Reechee url: https://reechee.io servers: - url: https://app.reechee.io/api/v1 description: Production security: - bearerAuth: [] tags: - name: System description: Health and connectivity. - name: Products description: Search products and read their pain points and competitors. - name: Opportunities description: Read and triage sales opportunities (API key required). - name: Watchlist description: Read and manage the team's followed products (API key required). - name: Account description: Team account data such as credit balance (API key required). - name: Credits description: >- Credit-spending actions (Tier 3). Requires a spend budget on the credential - a per-key spend cap for API keys, or the consent-time credit budget for OAuth connections. paths: /opportunities/{id}/reveal: post: tags: - Credits summary: Reveal the reviewer (5 credits) description: > Reveal who wrote the review behind an opportunity: the reviewer's name, title and LinkedIn, their company, the full review and its source link. On Pay as you go these stay hidden on `GET /opportunities` and `GET /opportunities/{id}` until the reveal. **Spends 5 credits** on Pay as you go (1 credit on plans from before pay-as-you-go pricing, where it reveals the reviewer's LinkedIn). Idempotent: an opportunity already revealed returns the same data with `credits_used: 0` and no charge. Not available for mention-sourced opportunities (`400`), whose author is public. Requires a **spend budget** on the credential (per-key spend cap, or an OAuth connection's consent-time credit budget). When the team is out of credits the `402` carries `details.top_up_url`, the page where you buy a credit pack. operationId: revealReviewer parameters: - $ref: '#/components/parameters/OpportunityId' responses: '200': description: The revealed opportunity. content: application/json: schema: type: object required: - success - data properties: success: type: boolean const: true data: $ref: '#/components/schemas/RevealReviewerResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PaymentRequired' '403': $ref: '#/components/responses/SpendCapRequired' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' security: - bearerAuth: [] components: parameters: OpportunityId: name: id in: path required: true description: Opportunity id (uuid). schema: type: string format: uuid schemas: RevealReviewerResponse: type: object required: - is_reviewer_revealed - credits_used - opportunity properties: is_reviewer_revealed: type: boolean const: true credits_used: type: integer description: >- The credits this call charged. 0 when the opportunity was already revealed. credits_remaining: type: integer description: Present when credits were charged. already_revealed: type: boolean description: >- Present and true when the opportunity was already revealed (no charge). opportunity: $ref: '#/components/schemas/OpportunityDetail' description: >- The opportunity as `GET /opportunities/{id}` now returns it, with the reviewer visible. OpportunityDetail: type: object required: - id - is_viewed - status - created_at - buying_committee - source properties: id: type: string format: uuid is_viewed: type: boolean is_committee_revealed: type: boolean is_reviewer_revealed: type: boolean is_reviewer_email_revealed: type: boolean is_reviewer_phone_revealed: type: boolean reviewer_email: type: - string - 'null' description: >- Null unless unlocked, and null when the unlock found nothing (see reviewer_email_not_found). reviewer_phone: type: - string - 'null' description: >- Null unless unlocked, and null when the unlock found nothing (see reviewer_phone_not_found). reviewer_email_not_found: type: boolean description: >- True when the email was unlocked but enrichment found nothing. Distinguishes a withheld value from a paid-for miss. reviewer_phone_not_found: type: boolean description: True when the phone was unlocked but enrichment found nothing. reviewer_email_source: type: - string - 'null' reviewer_phone_source: type: - string - 'null' buying_committee: $ref: '#/components/schemas/BuyingCommittee' status: type: string created_at: type: string format: date-time source: type: string description: > Which of `review` / `mention` is populated: `"review"` for a software review, `"linkedin"` or `"reddit"` for a social mention. example: review frustration_tier: type: - string - 'null' enum: - severe - moderate - mild - null description: > How unhappy the reviewer is, derived from their own rating and the extracted pain points: `severe` = rating 3 or below, or any pain point with major severity; `mild` = rating 4.5 or above with no major point; `moderate` = everything in between (including reviews with no rating). Null on social-sourced rows. example: severe mention: anyOf: - $ref: '#/components/schemas/OpportunityDetailMention' - type: 'null' review: anyOf: - $ref: '#/components/schemas/OpportunityDetailReview' - type: 'null' ErrorResponse: type: object required: - success - error properties: success: type: boolean const: false error: type: object required: - code - message properties: code: type: string enum: - invalid_request - unauthorized - payment_required - forbidden - not_found - rate_limited - internal_error message: type: string details: type: object description: Present only on some errors. Omitted otherwise, never `null`. additionalProperties: true BuyingCommittee: type: object required: - summary - is_revealed - members properties: summary: type: - object - 'null' description: >- Counts from the committee search, including the reviewer. Null while the committee is locked, and for older snapshots. properties: version: type: integer const: 1 candidate_count: type: integer description: People the search found. stored_count: type: integer description: People kept in `members`. cap: type: integer const: 10 truncated: type: boolean description: True when the search found more people than were kept. is_revealed: type: boolean members: type: - array - 'null' description: Null until the committee is unlocked; member objects once revealed. items: type: object additionalProperties: true OpportunityDetailMention: type: object description: > A social mention on the detail response: the list shape plus the post body and the author's public profile. The profile is not unlock-gated - a LinkedIn/Reddit author is already public, unlike a review's reviewer identity. properties: id: type: string format: uuid url: type: - string - 'null' text: type: - string - 'null' posted_at: type: - string - 'null' format: date-time sentiment: type: - string - 'null' has_buying_signal: type: - boolean - 'null' pain_points: type: - object - 'null' additionalProperties: true author_name: type: - string - 'null' author_headline: type: - string - 'null' author_title: type: - string - 'null' author_bio: type: - string - 'null' author_profile_url: type: - string - 'null' author_city: type: - string - 'null' author_country: type: - string - 'null' author_company_name: type: - string - 'null' author_company_logo: type: - string - 'null' author_company_linkedin_url: type: - string - 'null' author_company_website: type: - string - 'null' author_company_size: type: - string - 'null' author_company_industry: type: - string - 'null' author_company_description: type: - string - 'null' subreddit: type: - string - 'null' product: anyOf: - $ref: '#/components/schemas/OpportunityProduct' - type: 'null' OpportunityDetailReview: type: object description: > Review detail, also nested at `opportunity.review` in a reviewer-reveal response. Full-review fields are null for an unrevealed pricing-v2 reviewer, including company-known/reviewer-locked rows. Revealed v2 and legacy v1 readers receive the stored fields without generated replacement text. required: - review_title - pros - cons - general_comments properties: id: type: string format: uuid platform: type: string review_title: type: - string - 'null' description: >- Stored review title. Null while the pricing-v2 reviewer is hidden, or when no title is stored. pros: type: - string - 'null' description: >- Full stored pros text, without truncation. Null while the pricing-v2 reviewer is hidden, or when not stored. cons: type: - string - 'null' description: >- Full stored cons text, without truncation. Null while the pricing-v2 reviewer is hidden, or when not stored. general_comments: type: - string - 'null' description: >- Full stored general comments, without truncation. Null while the pricing-v2 reviewer is hidden, or when not stored. reviewer_name: type: - string - 'null' reviewer_title: type: - string - 'null' reviewer_company: type: - string - 'null' reviewer_company_logo: type: - string - 'null' rating: type: - number - 'null' review_url: type: - string - 'null' linkedin_lead_url: type: - string - 'null' description: Reviewer's personal LinkedIn. Null unless the reviewer is unlocked. linkedin_company_url: type: - string - 'null' published_at: type: string format: date-time company_industry: type: - string - 'null' company_size: type: - string - 'null' company_country: type: - string - 'null' company_description: type: - string - 'null' company_website: type: - string - 'null' enriched_company_name: type: - string - 'null' enriched_company_logo: type: - string - 'null' enriched_company_industry: type: - string - 'null' enriched_company_size: type: - string - 'null' enriched_company_country: type: - string - 'null' enriched_company_website: type: - string - 'null' enriched_company_linkedin: type: - string - 'null' enriched_reviewer_name: type: - string - 'null' enriched_reviewer_title: type: - string - 'null' enriched_reviewer_linkedin: type: - string - 'null' description: Null unless the reviewer is unlocked. enriched_reviewer_city: type: - string - 'null' enriched_reviewer_country: type: - string - 'null' pain_points_analysis: type: - object - 'null' additionalProperties: true product: anyOf: - $ref: '#/components/schemas/OpportunityProduct' - type: 'null' OpportunityProduct: type: object required: - id - name properties: id: type: string format: uuid name: type: string logo_url: type: - string - 'null' responses: BadRequest: description: The request was malformed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: invalid_request message: Invalid request Unauthorized: description: A valid API key is required (or the key was invalid/revoked/expired). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: unauthorized message: >- API key required. Start free at https://app.reechee.io/sign-up (no card needed), then create an API key in Settings or connect through OAuth. PaymentRequired: description: > The credit-spending call was blocked for payment reasons. `details.reason` distinguishes the two cases: - `spend_cap_reached` - the credential's rolling 30-day spend budget (per-key cap, or an OAuth connection's credit budget) would be exceeded; carries `spend_cap`, `spend_used`, `spend_remaining`, `credits_required`. - `out_of_credits` - the team's credit balance is too low; carries `credits_required`, `credits_remaining` and `top_up_url`, the page where the user buys a credit pack. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: payment_required message: API key spend cap reached details: reason: spend_cap_reached spend_cap: 100 spend_used: 100 spend_remaining: 0 credits_required: 1 SpendCapRequired: description: > The credential has no spend budget. Credit-spending (Tier 3) actions require one as a safety guardrail. For API keys, the spend cap is set when the key is created and cannot be added later: create a new key with a spend cap under Settings → API keys. For OAuth connections, reconnect and allow a credit budget on the consent screen. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: forbidden message: >- This API key has no spend cap. Create a new key with a spend cap under Settings > API keys to enable credit-spending tools. details: reason: spend_cap_required NotFound: description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: not_found message: Resource not found RateLimited: description: | The rate limit was exceeded. The response carries `Retry-After` and `X-RateLimit-*` headers. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer X-RateLimit-Limit: description: Requests allowed in the window. schema: type: integer X-RateLimit-Remaining: description: Requests remaining in the window. schema: type: integer X-RateLimit-Reset: description: Unix seconds when the window resets. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: rate_limited message: Rate limit exceeded details: retry_after_seconds: 12 limit: 60 remaining: 0 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: rch_live_… description: > An API key, sent as `Authorization: Bearer rch_live_…`. Create and revoke keys in the app under Settings → API keys. A Connected (OAuth) access token from the MCP Connect flow is accepted in the same header. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.