Quickstart

By the end of this guide, you'll have retrieved your Convo profile with an authenticated API request. You'll need the Convo desktop app to create your key.

Base URL: https://www.itsconvo.com/api/v1

Step 1: Create an API key

1. Open the Convo desktop app.
2. Go to Settings → API Keys → Create New Key.
3. Copy the key and store it securely. It's only shown once.

Send your key in the Authorization: Bearer header. Keep it on your server, out of browser code and public repositories. See Authentication for details.

Step 2: Make your first request

Call GET /user/profile to check your key and retrieve your profile, subscription, and API usage.

curl -H "Authorization: Bearer convo_your_key_here" \
  https://www.itsconvo.com/api/v1/user/profile

const res = await fetch("https://www.itsconvo.com/api/v1/user/profile", {
  headers: { Authorization: "Bearer convo_your_key_here" },
});
const { data } = await res.json();
console.log(data.subscription.tier);

import requests

resp = requests.get("https://www.itsconvo.com/api/v1/user/profile",
    headers={"Authorization": "Bearer convo_your_api_key_here"})
data = resp.json()["data"]

Step 3: Read the response

A successful request returns a data object. Your response will contain your account's values:

{
  "data": {
    "profile": { "name": "Alice Chen", "email": "alice@example.com" },
    "subscription": { "tier": "professional", "status": "active" },
    "apiUsage": { "aiGenerations": { "used": 12, "limit": 100, "remaining": 88 } }
  }
}

Rate limit headers, including X-RateLimit-Remaining, are included in the response. If you receive a 401, check that you copied the full key and included the Bearer prefix. See Error Codes for other responses.

What's Next?