docs: add Research API and CLI reference

Merged
SI
6mo ago
+7619-4871

Summary

  • Documentation-first spec for the recoup research primitive
  • 16 API endpoints under /api/research/ with OpenAPI schemas
  • Full CLI reference with all subcommands, flags, and a workflow example
  • Provider-agnostic — no mention of underlying data sources

What's documented

API endpoints (16):

  • Search, Profile, Metrics (14 platforms), Audience, Cities, Similar Artists, Playlists, Albums, Tracks, Career, Insights, Discover, Genres, Festivals, Web Search, Deep Research

CLI commands:

  • recoup research "Drake" — find artist
  • recoup research metrics/audience/cities/similar/playlists/albums/tracks/career/insights — structured data
  • recoup research discover — artist discovery by criteria
  • recoup research web — web search
  • recoup research report — comprehensive deep research
  • Workflow example showing a full artist research chain

Test plan

  • Preview docs locally with npx mintlify@latest dev
  • Verify all 16 MDX pages render from OpenAPI spec
  • Verify CLI docs section renders correctly
  • Verify navigation order in sidebar

Made with Cursor

Summary by CodeRabbit

  • New Features

    • Added a Research API surface (many endpoints) for artist search, discovery, profiles, metrics, audience, cities, similar artists, social URLs, Instagram posts, playlists, albums, tracks, career timelines, AI insights, genres, festivals, plus web & deep research endpoints; added content-agent webhook/callback endpoints.
    • Added an authenticated callback security scheme using a callback-secret header.

  • CLI

    • Added a recoup research command family with structured subcommands and example workflows.

  • Documentation

    • Added documentation pages and navigation for all research endpoints and CLI usage.