Quickstart Guide

Get up and running in 5 minutes

Add AI-powered communication context to your app. Connect your users' Gmail, Slack, and more — then query their data with natural language.

Create Free Account View API Reference

Get API Key

Create User

Add Connect

Query Data

Step 1

Get your API key

10 seconds

Sign up for a free Attrove account and create your first API key. You can create separate keys for development and production environments.

Free tier included: Get started with 1,000 API calls per month at no cost. No credit card required.

Create API Key

Step 2

Create a test user

1 minute

Call the /v1/users endpoint to provision a user. Each user represents one of your end-users who will connect their communication accounts.

const res = await fetch("https://api.attrove.com/v1/users", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.ATTROVE_API_KEY}`,
    "X-Auth-Type": "partner",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "[email protected]",
    client_id: "your-client-id",
  }),
});

const { token, id } = await res.json();
// Save this token — you'll need it to open Attrove Connect

import requests

res = requests.post(
    "https://api.attrove.com/v1/users",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "X-Auth-Type": "partner",
        "Content-Type": "application/json",
    },
    json={
        "email": "[email protected]",
        "client_id": "your-client-id",
    },
)

data = res.json()
token, user_id = data["token"], data["id"]

curl -X POST "https://api.attrove.com/v1/users" \
  -H "Authorization: Bearer $ATTROVE_API_KEY" \
  -H "X-Auth-Type: partner" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "client_id": "your-client-id"
  }'

Step 3

Add the connect button

2 minutes

Add a connect button to your app that redirects users to Attrove's OAuth flow. Once connected, you'll be able to query their communication data.

Preview: What your users will see

// Generate a short-lived integration token
const tokenRes = await fetch(`https://api.attrove.com/v1/users/${userId}/tokens`, {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.ATTROVE_API_KEY}`,
    "X-Auth-Type": "partner",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ client_id: "your-client-id" }),
});

const { token } = await tokenRes.json();

// Redirect user to connect their Gmail
window.location.href = `https://connect.attrove.com/integrations/connect?provider=gmail&token=${token}&user_id=${userId}`;

import requests, webbrowser

# Generate a short-lived integration token
resp = requests.post(
    f"https://api.attrove.com/v1/users/{user_id}/tokens",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "X-Auth-Type": "partner",
    },
    json={"client_id": "your-client-id"},
)
token = resp.json()["token"]

# Open Gmail connect flow
webbrowser.open(
    f"https://connect.attrove.com/integrations/connect?provider=gmail&token={token}&user_id={user_id}"
)

# Generate token and redirect
TOKEN=$(curl -s -X POST "https://api.attrove.com/v1/users/$USER_ID/tokens" \
  -H "Authorization: Bearer $ATTROVE_API_KEY" \
  -H "X-Auth-Type: partner" \
  -H "Content-Type: application/json" \
  -d '{"client_id":"your-client-id"}' | jq -r '.token')

open "https://connect.attrove.com/integrations/connect?provider=gmail&token=$TOKEN&user_id=$USER_ID"

Step 4

Query user data

1 minute

Once users have connected their accounts, use natural language queries to search across their communication data. Our AI understands context and returns relevant results with source citations.

Usage-based pricing: Each query counts against your plan's monthly quota. Check your dashboard for current usage.

Example queries to try:

// Query user's connected data with natural language
const res = await fetch(`https://api.attrove.com/v1/ai/query?user_id=${userId}`, {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${userToken}`, // Token from Step 2
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    query: "What did we promise ACME last week?",
    client_timezone: "America/Los_Angeles",
  }),
});

const { answer, sources } = await res.json();

import requests

# Query user's connected data with natural language
res = requests.post(
    f"https://api.attrove.com/v1/ai/query?user_id={user_id}",
    headers={"Authorization": f"Bearer {user_token}"},  # Token from Step 2
    json={
        "query": "What did we promise ACME last week?",
        "client_timezone": "America/Los_Angeles",
    },
)

data = res.json()
answer, sources = data["answer"], data["sources"]

curl -X POST "https://api.attrove.com/v1/ai/query?user_id=$USER_ID" \
  -H "Authorization: Bearer $USER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What did we promise ACME last week?",
    "client_timezone": "America/Los_Angeles"
  }'

You're ready to build!

Your integration is set up. Start building AI-powered features with your users' communication data.

View Full API Reference Go to Dashboard