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 500 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.

import { Attrove } from '@attrove/sdk';

const admin = Attrove.admin({
  clientId: process.env.ATTROVE_CLIENT_ID,
  clientSecret: process.env.ATTROVE_CLIENT_SECRET,
});

const { id, apiKey } = await admin.users.create({
  email: 'user@company.com',
});
// id: user UUID — apiKey: sk_ token for API calls

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": "user@company.com",
        "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_SECRET_KEY" \
  -H "X-Auth-Type: partner" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@company.com",
    "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

import { Attrove } from '@attrove/sdk';

const admin = Attrove.admin({
  clientId: process.env.ATTROVE_CLIENT_ID,
  clientSecret: process.env.ATTROVE_CLIENT_SECRET,
});

// Generate a short-lived token for the connect flow
const { token } = await admin.users.createConnectToken(userId);

// Redirect user to connect their Gmail
const connectUrl = new URL('https://connect.attrove.com/integrations/connect');
connectUrl.searchParams.set('provider', 'gmail');
connectUrl.searchParams.set('token', token);
connectUrl.searchParams.set('user_id', userId);
window.location.href = connectUrl.toString();

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_SECRET_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:

import { Attrove } from '@attrove/sdk';

const attrove = new Attrove({
  apiKey: userToken, // sk_ token from Step 2
  userId,
});

const { answer, used_message_ids, used_meeting_ids, used_event_ids } = await attrove.query(
  'What did we promise ACME last week?',
  { timezone: 'America/Los_Angeles' }
);
console.log(used_message_ids, used_meeting_ids, used_event_ids);

import requests

# Query user's connected data with natural language
res = requests.post(
    f"https://api.attrove.com/v1/users/{user_id}/query",
    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()["data"]
answer = data["answer"]
used_message_ids = data["used_message_ids"]
used_meeting_ids = data["used_meeting_ids"]
used_event_ids = data["used_event_ids"]

curl -X POST "https://api.attrove.com/v1/users/$USER_ID/query" \
  -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