Skip to content

index.mdx

Latest commit

 

History

History
187 lines (156 loc) · 6.98 KB

index.mdx

File metadata and controls

187 lines (156 loc) · 6.98 KB
title Recoup API Documentation
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. Generate content, Access artist analytics, Manage catalogs, Team chats, and task automation to power your record labels.

Quickest start — one curl call

Get a working API key in a single unauthenticated request. No dashboard, no browser, no human in the loop.

export RECOUP_API_KEY=$(curl -s -X POST "https://recoup-api.vercel.app/api/agents/signup" \
  -H "Content-Type: application/json" \
  -d '{"email": "agent+'$(date +%s)-$RANDOM'@recoupable.com"}' | jq -r .api_key)

$RECOUP_API_KEY is now ready to pass in the x-api-key header on any request. See the Agents guide for the full signup and verification flow.

What is Recoup?

Recoup is an AI agent platform for smarter song rollouts, unforgettable fan experiences, and lasting artist growth. Empowering music executives with actionable insights and next-gen tools.

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:

https://recoup-api.vercel.app/api

Authentication

Most API endpoints are authenticated using an API key passed in the x-api-key header. The only exceptions are the agent onboarding endpoints — POST /api/agents/signup and POST /api/agents/verify — which are intentionally unauthenticated so agents can obtain their first API key.

  1. Navigate to the API Keys Management Page
  2. Sign in with your account
  3. Create a new API key and copy it immediately (it's only shown once)
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

Get an API key in one curl call. The fastest path for AI agents — no dashboard required. Get your API key and make your first request in minutes. Install and use the Recoup CLI to interact with the platform from your terminal. Connect Recoup to AI assistants via the Model Context Protocol.

API Sections

The API is organized into six 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. Conversations with artist context. Create, stream, and generate messages. Copy messages, delete trailing messages, and manage chat history. Spotify, Instagram, X (Twitter), and generic social scraping. Search artists, scrape profiles and comments, track trends, and manage OAuth connectors. Songs, catalogs, and task management. Analyze songs, manage catalog collections, and schedule recurring tasks with cron-based automation. Accounts, organizations, workspaces, subscriptions, pulses, notifications, sandboxes, and admin tools.

Agents

Content creation agent accessible via Slack. Generates images, videos, and captions for artists automatically. 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/artists/* — Artist management (list, create, socials, socials-scrape, profile)
  • /api/research/* — Artist research (search, lookup, profile, metrics, audience, cities, similar, urls, instagram-posts, playlists, albums, track, 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, messages, messages-copy, messages-trailing-delete, create, update, delete, generate, stream, compact)
  • /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)
  • /api/agents/* — Agent onboarding (signup, verify) — no auth required

Base URL: https://recoup-api.vercel.app/api

OpenAPI Specification

Need Help?

<Card title="Contact Support" icon="envelope" href="mailto:agent@recoupable.com"

Reach out to our team at agent@recoupable.com for assistance with the Recoup API.