Skip to content

docs: add Research API and CLI reference #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sidneyswift wants to merge 16 commits into
base: main
Choose a base branch
from
Open

docs: add Research API and CLI reference #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
77f108e
docs: add Research API endpoints and CLI commands
sidneyswift Mar 27, 2026
32a041d
fix: remove credit mentions, clean up ID descriptions
sidneyswift Mar 27, 2026
b5f810a
fix: name-based lookups — no IDs exposed to users
sidneyswift Mar 27, 2026
2fc7395
feat: add 6 missing research endpoints from chartmetric skill
sidneyswift Mar 27, 2026
479a38b
feat: add research templates — pre-built multi-step workflows
sidneyswift Mar 27, 2026
cd85bd0
fix: scope artist name/ID rule to artist-scoped subcommands only
sidneyswift Mar 27, 2026
3a79775
revert: remove templates and run endpoints
sidneyswift Mar 27, 2026
a65f697
refactor: flat routes with query params to match Recoup API pattern
sidneyswift Mar 27, 2026
25d8600
fix: address CodeRabbit review feedback
sidneyswift Mar 27, 2026
3909b74
docs: clarify ResearchProxyResponse is intentionally untyped
sidneyswift Mar 27, 2026
1d9bde1
feat: add concrete response schemas for all research endpoints
sidneyswift Mar 27, 2026
30919da
fix: consolidate repeated artist-ID guidance per review nitpick
sidneyswift Mar 27, 2026
3f01179
fix: add missing descriptions to required platform params
sidneyswift Mar 28, 2026
f840ef5
feat: add people, extract, and enrich endpoints to docs
sidneyswift Mar 29, 2026
dcae6c3
feat: add milestones, venues, rank, charts, radio to docs
sidneyswift Mar 29, 2026
d832a6e
fix: replace Kaash Paige examples with Drake
sidneyswift Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8,643 changes: 5,409 additions & 3,234 deletions api-reference/openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions api-reference/research/albums.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Albums'
openapi: 'GET /api/research/albums'
---
4 changes: 4 additions & 0 deletions api-reference/research/audience.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Audience Demographics'
openapi: 'GET /api/research/audience'
---
4 changes: 4 additions & 0 deletions api-reference/research/career.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Career Timeline'
openapi: 'GET /api/research/career'
---
4 changes: 4 additions & 0 deletions api-reference/research/charts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Charts'
openapi: 'GET /api/research/charts'
---
4 changes: 4 additions & 0 deletions api-reference/research/cities.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Listener Cities'
openapi: 'GET /api/research/cities'
---
4 changes: 4 additions & 0 deletions api-reference/research/curator.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Curator'
openapi: 'GET /api/research/curator'
---
4 changes: 4 additions & 0 deletions api-reference/research/deep.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Deep Research'
openapi: 'POST /api/research/deep'
---
4 changes: 4 additions & 0 deletions api-reference/research/discover.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Discover Artists'
openapi: 'GET /api/research/discover'
---
4 changes: 4 additions & 0 deletions api-reference/research/enrich.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Enrich'
openapi: 'POST /api/research/enrich'
---
4 changes: 4 additions & 0 deletions api-reference/research/extract.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Extract URL'
openapi: 'POST /api/research/extract'
---
4 changes: 4 additions & 0 deletions api-reference/research/festivals.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Festivals'
openapi: 'GET /api/research/festivals'
---
4 changes: 4 additions & 0 deletions api-reference/research/genres.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Genres'
openapi: 'GET /api/research/genres'
---
4 changes: 4 additions & 0 deletions api-reference/research/insights.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'AI Insights'
openapi: 'GET /api/research/insights'
---
4 changes: 4 additions & 0 deletions api-reference/research/instagram-posts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Instagram Posts'
openapi: 'GET /api/research/instagram-posts'
---
4 changes: 4 additions & 0 deletions api-reference/research/lookup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Lookup by URL'
openapi: 'GET /api/research/lookup'
---
4 changes: 4 additions & 0 deletions api-reference/research/metrics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Platform Metrics'
openapi: 'GET /api/research/metrics'
---
4 changes: 4 additions & 0 deletions api-reference/research/milestones.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Milestones'
openapi: 'GET /api/research/milestones'
---
4 changes: 4 additions & 0 deletions api-reference/research/people.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'People Search'
openapi: 'POST /api/research/people'
---
4 changes: 4 additions & 0 deletions api-reference/research/playlist.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Playlist'
openapi: 'GET /api/research/playlist'
---
4 changes: 4 additions & 0 deletions api-reference/research/playlists.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Playlist Placements'
openapi: 'GET /api/research/playlists'
---
4 changes: 4 additions & 0 deletions api-reference/research/profile.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Artist Profile'
openapi: 'GET /api/research/profile'
---
4 changes: 4 additions & 0 deletions api-reference/research/radio.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Radio Stations'
openapi: 'GET /api/research/radio'
---
4 changes: 4 additions & 0 deletions api-reference/research/rank.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Artist Rank'
openapi: 'GET /api/research/rank'
---
4 changes: 4 additions & 0 deletions api-reference/research/search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Search'
openapi: 'GET /api/research'
---
4 changes: 4 additions & 0 deletions api-reference/research/similar.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Similar Artists'
openapi: 'GET /api/research/similar'
---
4 changes: 4 additions & 0 deletions api-reference/research/track.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Track'
openapi: 'GET /api/research/track'
---
4 changes: 4 additions & 0 deletions api-reference/research/tracks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Tracks'
openapi: 'GET /api/research/tracks'
---
4 changes: 4 additions & 0 deletions api-reference/research/urls.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Social URLs'
openapi: 'GET /api/research/urls'
---
4 changes: 4 additions & 0 deletions api-reference/research/venues.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Venues'
openapi: 'GET /api/research/venues'
---
4 changes: 4 additions & 0 deletions api-reference/research/web.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: 'Web Search'
openapi: 'POST /api/research/web'
---
Loading