diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx deleted file mode 100644 index 057216c..0000000 --- a/api-reference/introduction.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: 'Introduction' -description: 'API documentation for the Recoup platform - AI agents for the music industry' ---- - -## Welcome - -Welcome to the Recoup API documentation. Recoup is an AI agent platform for the music industry that provides artist analytics, fan segmentation, and AI-powered chat assistants. Build smarter song rollouts, create unforgettable fan experiences, and drive lasting artist growth. - - - View the OpenAPI specification file on GitHub - - -## Base URL - -All API requests should be made to: - -```bash -https://api.recoupable.com/api -``` - -## Authentication - -All API endpoints are authenticated using an API key passed in the `x-api-key` header. - -### Getting Your API Key - -1. Navigate to the [API Keys Management Page](https://chat.recoupable.com/keys) -2. Sign in with your account -3. Create a new API key and copy it immediately (it's only shown once) - -### Using Your API Key - -Include your API key in the `x-api-key` header for all requests: - -```bash -curl -X GET "https://api.recoupable.com/api/artists?accountId=YOUR_ACCOUNT_ID" \ - -H "Content-Type: application/json" \ - -H "x-api-key: YOUR_API_KEY" -``` - - -Keep your API key secure. Do not share it publicly or commit it to version control. - - -## Next Steps - - - - Get started with your first API request - - - Explore all available endpoints - - diff --git a/docs.json b/docs.json index 11c47fb..119390f 100644 --- a/docs.json +++ b/docs.json @@ -11,7 +11,7 @@ "navigation": { "tabs": [ { - "tab": "Guides", + "tab": "Quickstart", "groups": [ { "group": "Getting started", @@ -32,154 +32,179 @@ ] }, { - "tab": "API reference", + "tab": "Research", "groups": [ - { - "group": "API documentation", - "pages": [ - "api-reference/introduction" - ] - }, { "group": "Chat", "pages": [ + "api-reference/chat/stream", + "api-reference/chat/create", "api-reference/chat/chats", "api-reference/chat/artist", "api-reference/chat/segment", "api-reference/chat/messages", "api-reference/chat/messages-copy", "api-reference/chat/messages-trailing-delete", - "api-reference/chat/create", "api-reference/chat/update", "api-reference/chat/delete", "api-reference/chat/generate", - "api-reference/chat/stream", "api-reference/chat/compact" ] }, { - "group": "Pulses", + "group": "Research", "pages": [ - "api-reference/pulses/list", - "api-reference/pulses/update" + "api-reference/research/search", + "api-reference/research/lookup", + "api-reference/research/profile", + "api-reference/research/metrics", + "api-reference/research/audience", + "api-reference/research/cities", + "api-reference/research/similar", + "api-reference/research/urls", + "api-reference/research/instagram-posts", + "api-reference/research/playlists", + "api-reference/research/albums", + "api-reference/research/tracks", + "api-reference/research/track", + "api-reference/research/career", + "api-reference/research/insights", + "api-reference/research/playlist", + "api-reference/research/curator", + "api-reference/research/discover", + "api-reference/research/genres", + "api-reference/research/festivals", + "api-reference/research/web", + "api-reference/research/deep", + "api-reference/research/people", + "api-reference/research/extract", + "api-reference/research/enrich", + "api-reference/research/milestones", + "api-reference/research/venues", + "api-reference/research/rank", + "api-reference/research/charts", + "api-reference/research/radio" ] - }, + } + ] + }, + { + "tab": "Releases", + "groups": [ { - "group": "Tasks", + "group": "Artists", "pages": [ - "api-reference/tasks/get", - "api-reference/tasks/create", - "api-reference/tasks/update", - "api-reference/tasks/delete", - "api-reference/tasks/runs" + "api-reference/artists/list", + "api-reference/artists/create", + "api-reference/artist/segments", + "api-reference/artist/socials", + "api-reference/artist/socials-scrape", + "api-reference/artist/profile" ] }, { - "group": "Accounts", + "group": "Songs & Catalogs", "pages": [ - "api-reference/accounts/get", - "api-reference/accounts/id", - "api-reference/accounts/create", - "api-reference/accounts/update", - "api-reference/accounts/add-artist" + "api-reference/songs/songs", + "api-reference/songs/create", + "api-reference/songs/analyze", + "api-reference/songs/analyze-presets", + "api-reference/songs/catalogs", + "api-reference/songs/catalogs-create", + "api-reference/songs/catalogs-delete", + "api-reference/songs/catalog-songs", + "api-reference/songs/catalog-songs-add", + "api-reference/songs/catalog-songs-delete" ] }, { - "group": "Admins", + "group": "Tasks", "pages": [ - "api-reference/admins/check", - "api-reference/admins/sandboxes", - "api-reference/admins/sandboxes-orgs", - "api-reference/admins/emails", - "api-reference/admins/privy", - "api-reference/admins/coding-agent-slack-tags", - "api-reference/admins/coding-pr", - "api-reference/admins/content-slack-tags" + "api-reference/tasks/get", + "api-reference/tasks/create", + "api-reference/tasks/update", + "api-reference/tasks/delete", + "api-reference/tasks/runs" ] }, { - "group": "Artists", + "group": "Fans & Segments", "pages": [ - "api-reference/artists/list", - "api-reference/artists/create", - "api-reference/artist/segments", - "api-reference/artist/socials", - "api-reference/artist/socials-scrape", - "api-reference/artist/profile" + "api-reference/segment/fans", + "api-reference/fans/get" ] - }, + } + ] + }, + { + "tab": "Content", + "groups": [ { - "group": "Segment", + "group": "Posts & Comments", "pages": [ - "api-reference/segment/fans" + "api-reference/posts/get", + "api-reference/post/comments", + "api-reference/comments/get" ] }, { - "group": "Fans", + "group": "Content Creation", "pages": [ - "api-reference/fans/get" + "api-reference/content/create", + "api-reference/content/generate-image", + "api-reference/content/generate-video", + "api-reference/content/generate-caption", + "api-reference/content/transcribe-audio", + "api-reference/content/edit", + "api-reference/content/upscale", + "api-reference/content/analyze-video", + "api-reference/content/templates", + "api-reference/content/validate", + "api-reference/content/estimate" ] }, { - "group": "Posts", + "group": "Content Agent", "pages": [ - "api-reference/posts/get", - "api-reference/post/comments" + "api-reference/content-agent/webhook", + "api-reference/content-agent/callback" ] }, { - "group": "Comments", + "group": "Image", "pages": [ - "api-reference/comments/get" + "api-reference/image/generation" ] }, { - "group": "Organizations", + "group": "Transcribe", "pages": [ - "api-reference/organizations/list", - "api-reference/organizations/create", - "api-reference/organizations/add-artist" + "api-reference/transcribe/audio" ] }, { - "group": "Workspaces", + "group": "Sandboxes", "pages": [ - "api-reference/workspaces/create" + "api-reference/sandboxes/list", + "api-reference/sandboxes/create", + "api-reference/sandboxes/snapshot", + "api-reference/sandboxes/delete", + "api-reference/sandboxes/setup", + "api-reference/sandboxes/file", + "api-reference/sandboxes/upload" ] - }, + } + ] + }, + { + "tab": "Social Media", + "groups": [ { - "group": "Research", + "group": "Connectors", "pages": [ - "api-reference/research/search", - "api-reference/research/lookup", - "api-reference/research/profile", - "api-reference/research/metrics", - "api-reference/research/audience", - "api-reference/research/cities", - "api-reference/research/similar", - "api-reference/research/urls", - "api-reference/research/instagram-posts", - "api-reference/research/playlists", - "api-reference/research/albums", - "api-reference/research/tracks", - "api-reference/research/track", - "api-reference/research/career", - "api-reference/research/insights", - "api-reference/research/playlist", - "api-reference/research/curator", - "api-reference/research/discover", - "api-reference/research/genres", - "api-reference/research/festivals", - "api-reference/research/web", - "api-reference/research/deep", - "api-reference/research/people", - "api-reference/research/extract", - "api-reference/research/enrich", - "api-reference/research/milestones", - "api-reference/research/venues", - "api-reference/research/rank", - "api-reference/research/charts", - "api-reference/research/radio" + "api-reference/connectors/list", + "api-reference/connectors/authorize", + "api-reference/connectors/disconnect" ] }, { @@ -214,91 +239,70 @@ ] }, { - "group": "Image", - "pages": [ - "api-reference/image/generation" - ] - }, - { - "group": "Transcribe", - "pages": [ - "api-reference/transcribe/audio" - ] - }, - { - "group": "Songs & Catalogs", + "group": "Apify", "pages": [ - "api-reference/songs/songs", - "api-reference/songs/create", - "api-reference/songs/analyze", - "api-reference/songs/analyze-presets", - "api-reference/songs/catalogs", - "api-reference/songs/catalogs-create", - "api-reference/songs/catalogs-delete", - "api-reference/songs/catalog-songs", - "api-reference/songs/catalog-songs-add", - "api-reference/songs/catalog-songs-delete" + "api-reference/apify/scraper" ] - }, + } + ] + }, + { + "tab": "Accounts", + "groups": [ { - "group": "Subscriptions", + "group": "Pulses", "pages": [ - "api-reference/subscriptions/get" + "api-reference/pulses/update", + "api-reference/pulses/list" ] }, { - "group": "Notifications", + "group": "Accounts", "pages": [ - "api-reference/notifications/create" + "api-reference/accounts/get", + "api-reference/accounts/id", + "api-reference/accounts/create", + "api-reference/accounts/update", + "api-reference/accounts/add-artist" ] }, { - "group": "Apify", + "group": "Organizations", "pages": [ - "api-reference/apify/scraper" + "api-reference/organizations/list", + "api-reference/organizations/create", + "api-reference/organizations/add-artist" ] }, { - "group": "Sandboxes", + "group": "Workspaces", "pages": [ - "api-reference/sandboxes/list", - "api-reference/sandboxes/create", - "api-reference/sandboxes/snapshot", - "api-reference/sandboxes/delete", - "api-reference/sandboxes/setup", - "api-reference/sandboxes/file", - "api-reference/sandboxes/upload" + "api-reference/workspaces/create" ] }, { - "group": "Connectors", + "group": "Subscriptions", "pages": [ - "api-reference/connectors/list", - "api-reference/connectors/authorize", - "api-reference/connectors/disconnect" + "api-reference/subscriptions/get" ] }, { - "group": "Content", + "group": "Admins", "pages": [ - "api-reference/content/create", - "api-reference/content/generate-image", - "api-reference/content/generate-video", - "api-reference/content/generate-caption", - "api-reference/content/transcribe-audio", - "api-reference/content/edit", - "api-reference/content/upscale", - "api-reference/content/analyze-video", - "api-reference/content/templates", - "api-reference/content/validate", - "api-reference/content/estimate" + "api-reference/admins/check", + "api-reference/admins/sandboxes", + "api-reference/admins/sandboxes-orgs", + "api-reference/admins/emails", + "api-reference/admins/privy", + "api-reference/admins/coding-agent-slack-tags", + "api-reference/admins/coding-pr", + "api-reference/admins/content-slack-tags" ] }, { - "group": "Content Agent", + "group": "Notifications", "pages": [ - "api-reference/content-agent/webhook", - "api-reference/content-agent/callback" + "api-reference/notifications/create" ] } ] diff --git a/index.mdx b/index.mdx index 05c0125..7d6fef4 100644 --- a/index.mdx +++ b/index.mdx @@ -1,11 +1,11 @@ --- title: "Recoup API Documentation" -description: "Use the Recoup API to build your record label." +description: "Use the Recoup API to build your record label. Access research, content creation, chat, artist analytics, social media, and platform management endpoints." --- # Welcome to the Recoup API -Use the Recoup API to build your record label. Access artist analytics, fan segmentation, AI-powered chat, and task automation to power your music business. +Use the Recoup API to build your record label. Access artist analytics, fan segmentation, AI-powered chat, content creation, and task automation to power your music business. ## What is Recoup? @@ -13,9 +13,35 @@ Recoup is an AI agent platform for smarter song rollouts, unforgettable fan expe This is where record labels, musicians, and managers start to build on Recoup AI technology like chat, tasks, agents, and more. +## Base URL + +All API requests should be made to: + +```bash +https://recoup-api.vercel.app/api +``` + +## Authentication + +All API endpoints are authenticated using an API key passed in the `x-api-key` header. + +1. Navigate to the [API Keys Management Page](https://chat.recoupable.com/keys) +2. Sign in with your account +3. Create a new API key and copy it immediately (it's only shown once) + +```bash +curl -X GET "https://recoup-api.vercel.app/api/artists?accountId=YOUR_ACCOUNT_ID" \ + -H "Content-Type: application/json" \ + -H "x-api-key: YOUR_API_KEY" +``` + + +Keep your API key secure. Do not share it publicly or commit it to version control. + + ## Get Started - + - Explore all available endpoints and integrations. + Install and use the Recoup CLI to interact with the platform from your terminal. + + + Connect Recoup to AI assistants via the Model Context Protocol. -## Key Capabilities +## API Sections + +The API is organized into five main sections. Use these links to jump to the right area. + 30 endpoints for artist research: search, lookup, profile, metrics, audience, cities, similar artists, playlists, albums, tracks, career history, insights, genres, festivals, web presence, and more. + + + Generate images, videos, and captions. Transcribe audio, edit content, upscale media, analyze videos, manage templates, and estimate costs. + + - AI-powered conversations with artist context. Stream responses or generate complete messages. + AI-powered conversations with artist context. Create, stream, and generate messages. Copy messages, delete trailing messages, and manage chat history. - Comprehensive artist profiles with social metrics, follower counts, and engagement data across platforms. + Spotify, Instagram, X (Twitter), and generic social scraping. Search artists, scrape profiles and comments, track trends, and manage OAuth connectors. - Organize and analyze fan bases by demographics, engagement levels, and behavior patterns. + Songs, catalogs, and task management. Analyze songs, manage catalog collections, and schedule recurring tasks with cron-based automation. - Schedule and automate recurring tasks with cron-based scheduling and AI-powered execution. + Accounts, organizations, workspaces, subscriptions, pulses, notifications, sandboxes, and admin tools. -## Platform Integrations +## Agents - - - Search artists, albums, and tracks. - + - Scrape profiles and comments. + AI content creation agent accessible via Slack. Generates images, videos, and captions for artists automatically. - Search tweets and trending topics. + API key authentication, account-scoped access, and organization-level permissions. +## Quick Reference for LLMs + +If you are an LLM navigating these docs, here is a summary of the endpoint structure: + +- **`/api/research/*`** — Artist research (search, lookup, profile, metrics, audience, cities, similar, urls, playlists, albums, tracks, career, insights, genres, festivals, web, deep, people, extract, enrich, milestones, venues, rank, charts, radio, discover, curator, playlist) +- **`/api/content/*`** — Content creation (create, generate-image, generate-video, generate-caption, transcribe-audio, edit, upscale, analyze-video, templates, validate, estimate) +- **`/api/chat/*`** — Chat (chats, artist, segment, messages, messages-copy, messages-trailing-delete, create, update, delete, generate, stream, compact) +- **`/api/artists/*`** — Artist management (list, create, segments, socials, socials-scrape, profile) +- **`/api/songs/*`** — Songs and catalogs (songs, create, analyze, analyze-presets, catalogs, catalogs-create, catalogs-delete, catalog-songs, catalog-songs-add, catalog-songs-delete) +- **`/api/tasks/*`** — Task automation (get, create, update, delete, runs) +- **`/api/spotify/*`** — Spotify (search, artist, artist-albums, artist-top-tracks, album) +- **`/api/instagram/*`** — Instagram (comments, profiles) +- **`/api/x/*`** — X/Twitter (search, trends) +- **`/api/connectors/*`** — OAuth connectors (list, authorize, disconnect) +- **`/api/accounts/*`** — Accounts (get, id, create, update, add-artist) +- **`/api/organizations/*`** — Organizations (list, create, add-artist) +- **`/api/sandboxes/*`** — Sandboxes (list, create, snapshot, delete, setup, file, upload) +- **`/api/content-agent/*`** — Content agent webhooks (webhook, callback) + +Base URL: `https://recoup-api.vercel.app/api` + +[OpenAPI Specification](https://github.com/sweetmantech/docs/blob/main/api-reference/openapi.json) + ## Need Help? - Reach out to our team for assistance with the Recoup API. + Reach out to our team at agent@recoupable.com for assistance with the Recoup API. diff --git a/quickstart.mdx b/quickstart.mdx index cc7e37b..90ac94c 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -8,7 +8,7 @@ description: "Get your API key and make your first request to the Recoup API." All API requests should be made to: ```bash -https://api.recoupable.com/api +https://recoup-api.vercel.app/api ``` ## API Keys @@ -37,7 +37,7 @@ Once you have your API key, include it in the `x-api-key` header for all authent ```bash cURL -curl -X GET "https://api.recoupable.com/api/tasks" \ +curl -X GET "https://recoup-api.vercel.app/api/tasks" \ -H "Content-Type: application/json" \ -H "x-api-key: YOUR_API_KEY" ``` @@ -51,14 +51,14 @@ headers = { } response = requests.get( - "https://api.recoupable.com/api/tasks", + "https://recoup-api.vercel.app/api/tasks", headers=headers ) print(response.json()) ``` ```javascript JavaScript -const response = await fetch("https://api.recoupable.com/api/tasks", { +const response = await fetch("https://recoup-api.vercel.app/api/tasks", { headers: { "Content-Type": "application/json", "x-api-key": "YOUR_API_KEY", @@ -84,7 +84,7 @@ interface TasksResponse { tasks: Task[]; } -const response = await fetch("https://api.recoupable.com/api/tasks", { +const response = await fetch("https://recoup-api.vercel.app/api/tasks", { headers: { "Content-Type": "application/json", "x-api-key": "YOUR_API_KEY",