Skip to content

quickstart.mdx

Latest commit

 

History

History
159 lines (129 loc) · 3.54 KB

quickstart.mdx

File metadata and controls

159 lines (129 loc) · 3.54 KB
title Quickstart
description Get your API key and make your first request to the Recoup API.

Base URL

All API requests should be made to:

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

API Keys

To access the Recoup API programmatically, you'll need to create an API key.

Step 1: Access the API Keys Management Page

  1. Navigate to the Recoup API Keys Management Page
  2. Sign in with your account if you haven't already

Step 2: Create Your API Key

  1. On the API Keys page, you'll see a form to create a new API key
  2. Enter a descriptive name for your API key (e.g., "My Development Key", "Production API Key")
  3. Click the "Create API Key" button
Copy and securely store your API key immediately - it will only be shown once!

Step 3: Use Your API Key

Once you have your API key, include it in the x-api-key header for all authenticated requests. Here's a simple example that retrieves your scheduled tasks:

curl -X GET "https://recoup-api.vercel.app/api/tasks" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY"
import requests

headers = {
    "Content-Type": "application/json",
    "x-api-key": "YOUR_API_KEY"
}

response = requests.get(
    "https://recoup-api.vercel.app/api/tasks",
    headers=headers
)
print(response.json())
const response = await fetch("https://recoup-api.vercel.app/api/tasks", {
  headers: {
    "Content-Type": "application/json",
    "x-api-key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
interface Task {
  id: string;
  title: string;
  prompt: string;
  schedule: string;
  account_id: string;
  artist_account_id: string;
  enabled: boolean;
}

interface TasksResponse {
  status: "success" | "error";
  tasks: Task[];
}

const response = await fetch("https://recoup-api.vercel.app/api/tasks", {
  headers: {
    "Content-Type": "application/json",
    "x-api-key": "YOUR_API_KEY",
  },
});
const data: TasksResponse = await response.json();
console.log(data.tasks);

Example Response:

{
  "status": "success",
  "tasks": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "title": "Daily Fan Report",
      "prompt": "Generate a summary of new fans from the past 24 hours",
      "schedule": "0 9 * * *",
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "artist_account_id": "987fcdeb-51a2-3b4c-d5e6-789012345678",
      "enabled": true
    }
  ]
}
For full documentation on the Tasks API including filtering options, see the [Tasks API Reference](/api-reference/tasks/get).

Next Steps

With your API key ready, you can now:

Fetch artist profiles, social accounts, and segments. Access fan data across all connected social platforms. Build AI-powered conversations with artist context. Schedule and automate recurring tasks.

Support

If you need help or have questions about the API, please contact our support team at agent@recoupable.com.