# Introduction

Welcome to the official Airaa documentation.

<figure><img src="/files/ynfcVXGKwCtMxkGKTO2H" alt=""><figcaption></figcaption></figure>

Airaa is a creator marketing platform that lets brands build and own their creator communities - running UGC, clipping, and KOL campaigns across TikTok, Instagram, YouTube, and X, all paid in 48-hour USDC.

***

## Where do you want to start?

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>For Brands</strong><br>Launch campaigns, build your creator community, and track performance.</td><td><a href="/pages/YP2nnPrtvFjuCu5TmEJK">/pages/YP2nnPrtvFjuCu5TmEJK</a></td></tr><tr><td><strong>For Creators</strong><br>Discover campaigns, complete tasks, and earn USDC.</td><td><a href="/pages/kAsAv4O56cUFhYfTDouI">/pages/kAsAv4O56cUFhYfTDouI</a></td></tr><tr><td><strong>API Reference</strong><br>Programmatic access to creator intelligence and leaderboard data.</td><td><a href="/pages/iV5pxsAyFHMB6llejKLO">/pages/iV5pxsAyFHMB6llejKLO</a></td></tr></tbody></table>

***

Airaa v2 is live. [Launch a campaign →](https://app.airaa.xyz)


# What is Airaa?

Airaa is a creator marketing platform built for brands that run ongoing creator programs - not one-off campaigns.

Most platforms treat every campaign as a fresh start. You source new creators, negotiate rates, chase content, and process payments manually. Then you do it all again next month. Airaa is built around a different model: your creator community persists, and campaigns run inside it.

## The core model

When you join Airaa, you create a **Community** - a brand-owned creator hub that belongs to you. Creators join your Community once. After that, you can run any campaign type against that community without rebuilding from scratch each time.

Every campaign generates performance data that accumulates on each creator's profile. Over time, you know exactly which creators drive results for your brand specifically - not just which ones have large followings.

## What Airaa handles

| What you control          | What Airaa handles                             |
| ------------------------- | ---------------------------------------------- |
| Campaign brief and budget | Creator verification and eligibility           |
| Reward structure          | Content review and quality scoring             |
| Community visibility      | USDC payouts within 48 hours                   |
| Creator invitations       | Tax documentation (1099s, international forms) |

## Who uses Airaa

**Brands** - web3 projects, DTC ecommerce companies, and B2B SaaS teams running creator marketing at scale. Typically managing 50–50,000+ creators across recurring campaigns.

**Agencies** - managing creator programs on behalf of clients, with role-based access for team collaboration.

**Creators** - content creators on TikTok, Instagram, YouTube, and X earning USDC for completing brand campaigns.

## Key numbers

* 50,000+ verified creators in the network
* 48-hour USDC payouts, no invoices
* 4 campaign types: Instant Tasks, UGC, Clipping, Aura Board
* Platforms: TikTok, Instagram, YouTube, X

***

Ready to start? Choose your path:

* [I'm a brand →](/getting-started/for-brands)
* [I'm a creator →](/getting-started/for-creators)


# For Brands

Get your brand's creator community live in under 30 minutes.

<figure><img src="/files/UShX3oKviPih1X6TIVh6" alt=""><figcaption></figcaption></figure>

## Step 1: Create your Community

A Community is your brand's private creator hub on Airaa. Everything - campaigns, creator profiles, performance data, and payout history - lives inside it.

Go to [app.airaa.xyz](https://app.airaa.xyz) and create your Community. You'll set:

* **Name and branding** - how creators see your brand
* **Visibility** - public (discoverable by creators in the Airaa network) or private (invite-only)
* **Niche and region** - used to surface your Community to relevant creators

## Step 2: Add creators

Two ways to populate your Community:

**Invite existing creators -** share your community link to the creators you work and easily onboard them.

**Open to applications** - toggle your Community to public. Creators from Airaa's 50,000+ network can apply. You approve or reject each application.

You can run both simultaneously.

## Step 3: Launch a campaign

Inside your Community, open the **Campaign App Store** and pick a campaign type:

| Campaign                                  | Best for                               | Min budget |
| ----------------------------------------- | -------------------------------------- | ---------- |
| [Instant Tasks](/campaigns/instant-tasks) | Fast reach, follows, quotes, referrals | $100 USDC  |
| [UGC](/campaigns/ugc)                     | Short-form video content at scale      | Custom     |
| [Clipping](/campaigns/clipping)           | Repurposing long-form into clips       | Custom     |
| [Aura Board](/campaigns/aura-board)       | KOL mindshare competition, pre-TGE     | Custom     |

Configure your brief, set eligibility filters, fund the campaign, and launch. Airaa handles verification, approval, and payouts automatically.

## Step 4: Track performance

Your Community dashboard shows creator-level performance across all campaigns: views, engagement, submissions, payout history, and quality scores. Data is exportable at any time.

***

## Pricing

Airaa is sold as a SaaS subscription. Creator reward budgets are separate and fully controlled by you. [Book a call](https://cal.com/airaa) to scope the right plan for your Community.

For Instant Tasks, Airaa charges a **15% platform fee** on top of the creator reward budget.


# For Creators

Earn USDC by creating content for brands. No invoices, no wire transfers, no waiting.

<figure><img src="/files/G2xCfreeFIUaGLJnD0vq" alt=""><figcaption></figcaption></figure>

## Requirements

All you need is an active social media account on at least one supported platform: **TikTok, Instagram, YouTube, or X (Twitter)**

## Step 1: Sign up

Go to [app.airaa.xyz](https://app.airaa.xyz) and sign up with your email or connect your X account.

If you sign up with email, Airaa automatically generates a **Base wallet** for you - no prior crypto experience needed. You can also link an existing MetaMask or Coinbase Wallet.

## Step 2: Connect your social accounts

Connect the platforms you create on: TikTok, Instagram, YouTube, or X. Airaa reads your profile data - follower count, engagement history, and smart followers - to determine your eligibility for campaigns.

Enable the **Telegram bot** to get instant alerts when campaigns you're eligible for go live.

## Step 3: Join Communities

Communities are brand-owned creator hubs. Browse the public directory and apply to Communities that match your niche. Some Communities are invite-only - brands will send you a direct link.

You can be a member of multiple Communities at once.

<figure><img src="/files/SnFdfb49Fm1ddVFomAic" alt=""><figcaption></figcaption></figure>

## Step 4: Complete campaigns

Inside each Community, you'll see available campaigns. Your eligibility for each campaign depends on:

* Your **Quality Score** (Aura Score)
* Follower count and engagement rate
* Location and niche match
* Platform requirements

Select a campaign, read the brief, submit your content, and get paid in USDC within 48 hours of approval.

***

## Campaign types and earnings

| Campaign      | What you do                               | Earnings              |
| ------------- | ----------------------------------------- | --------------------- |
| Instant Tasks | Post, quote, follow, or refer             | $5–$50 per action     |
| UGC           | Create a brand-briefed short-form video   | $200–$2,500 per video |
| Clipping      | Clip a long-form video into short content | $5–$30 per clip       |
| Aura Board    | Compete for KOL mindshare                 | Share of a prize pool |

***

* [Learn about payouts →](/creators/payouts)
* [Understand your Quality Score →](/creators/quality-scores)


# Overview

A Community is a brand-owned creator hub that persists across campaigns. It's the foundational unit of Airaa - everything else runs inside it.

<figure><img src="/files/VpdW9tNeNRmoFrFOtXuA" alt=""><figcaption></figcaption></figure>

## Why Communities exist

Traditional creator marketplaces reset with every campaign. You source creators, run a campaign, and those relationships disappear. The next campaign starts from zero.

Airaa's model is different. Your Community accumulates:

* **Creator profiles** - with quality scores that build across every campaign
* **Campaign history** - every submission, approval, and payout, all linked to the creator who produced it
* **Performance data** - cross-platform analytics tied to your specific brand, not platform averages

Over time, you know exactly who your top performers are - not because they have large followings, but because they've delivered results for you.

## What a Community includes

| Feature             | Description                                             |
| ------------------- | ------------------------------------------------------- |
| Creator roster      | All members, with profiles, scores, and history         |
| Campaign App Store  | Launch any campaign type from inside the Community      |
| Analytics dashboard | Cross-campaign, cross-platform performance              |
| Payout history      | Full record of all creator payments                     |
| Data export         | Export creator lists, campaign data, and payout records |

## Ownership

Your Community belongs to your brand. Airaa does not have access to your creator list for other brands' campaigns. You can export all data at any time.

***

* [Creating your Community →](/communities/creating-your-community)
* [Managing creators →](/communities/managing-creators)


# Creating Your Community

## Setup

Go to [app.airaa.xyz](https://app.airaa.xyz) and click **Create Community**. You'll configure:

**Name and branding** Your Community name and logo are visible to creators when they browse the directory or receive an invitation.

**Category and niche** Select the verticals that match your brand (e.g., web3, gaming, DTC, fitness). This determines which creators Airaa surfaces your Community to.

**Region** Set a primary region or leave global. Campaigns can override this with per-campaign geo filters.

**Visibility**

| Setting | Who can find it                   | Who can join                      |
| ------- | --------------------------------- | --------------------------------- |
| Public  | All creators in the Airaa network | Anyone (you approve applications) |
| Private | No one - invite-only              | Only creators you invite directly |

You can switch visibility at any time. Switching to private does not remove existing members.

## Funding

Communities themselves are free to create. Campaign budgets are funded separately, in USDC on Base, at the time of campaign launch.

***

* [Managing creators →](/communities/managing-creators)
* [Launch your first campaign →](/campaigns/overview)


# Managing Creators

## Adding creators

<figure><img src="/files/SXqWWbiQdEfZp5MpAUwz" alt=""><figcaption></figcaption></figure>

**Adding creators**

**Invitations** Send direct invitations via email address or wallet address. Use this for existing ambassadors or curated lists. Invited creators receive a link to join your Community - they do not need to apply.

**Open applications** Set your Community to public and creators from Airaa's network can apply. You review each application and approve or reject it. Approved creators become full members immediately.

## Creator profiles

Each creator in your Community has a profile showing:

* Connected platforms and account stats (followers, engagement rate)
* **Quality Score** - Airaa's composite reliability and performance score
* Campaign history within your Community - submissions, approvals, rejections
* Lifetime earnings from your Community
* Content samples from past campaigns

## Removing creators

You can remove a creator from your Community at any time. Removal does not affect completed campaigns or payouts. Removed creators retain their Airaa account and can join other Communities.

## Roles and access

Multiple team members can manage a Community. Available roles:

| Role   | Permissions                                        |
| ------ | -------------------------------------------------- |
| Owner  | Full access, billing, delete Community             |
| Admin  | Manage creators, launch campaigns, view analytics  |
| Viewer | View-only access to analytics and creator profiles |

Add team members from **Community Settings → Team**.

## Exporting data

Export your full creator roster, campaign performance data, and payout history as CSV from **Community Settings → Export**. You own this data.


# Campaign Types

Campaigns run inside your Community. Pick a type from the Campaign App Store, configure the brief, and launch.

<figure><img src="/files/VaYYHiE17ttTS81qtbwt" alt=""><figcaption></figcaption></figure>

## Available campaign types

| Campaign                                  | Best for                                | Setup          | Min budget    |
| ----------------------------------------- | --------------------------------------- | -------------- | ------------- |
| [Instant Tasks](/campaigns/instant-tasks) | Fast reach, actions, referrals          | Self-serve     | $100 USDC     |
| [UGC](/campaigns/ugc)                     | Short-form video content                | Self-serve     | Contact Airaa |
| [Clipping](/campaigns/clipping)           | Distributing long-form content as clips | Self-serve     | Contact Airaa |
| [Aura Board](/campaigns/aura-board)       | KOL mindshare competition               | Via Airaa team | Custom        |

## How campaigns work

1. **Configure** - Set your brief, eligibility filters, reward structure, and budget
2. **Fund** - Deposit USDC on Base to activate the campaign
3. **Launch** - Creators in your Community are notified via Telegram and the Airaa app
4. **Review** - Airaa's AI verifies submissions; you review flagged content
5. **Pay** - Approved creators receive USDC within 48 hours

## Eligibility filters

All campaigns let you filter which creators are eligible:

* Minimum follower count (per platform)
* Quality Score threshold
* Location / region
* Niche or vertical
* Specific creator list (allowlist)

## Reward structures

| Structure                       | How it works                                                      |
| ------------------------------- | ----------------------------------------------------------------- |
| FCFS (First Come, First Served) | Budget distributed until it runs out                              |
| Raffle                          | All eligible completions entered; winners selected randomly       |
| Leaderboard                     | Top performers ranked by a metric; prize pool distributed by rank |
| Milestone                       | Fixed reward per verified completion, up to a cap                 |

## After launch

Once a campaign is live, **it cannot be paused or cancelled.** Unspent budget is withdrawable after 7 days.

Airaa's AI handles content verification automatically. You only need to review submissions manually if they're flagged for brand safety or quality issues.

***

## Roadmap

Coming soon: Affiliate Tracking, Referral Bounty, Whitelist Drop, Live Show, Email Drop, Community Quest (Discord/Telegram engagement).


# Instant Tasks

Action-based campaigns that pay creators per verified completion. Best for fast reach, follower growth, and viral amplification.

## Task types

| Task     | What the creator does                            | Typical reward      |
| -------- | ------------------------------------------------ | ------------------- |
| Post     | Publish an original post on a specified platform | $10–$50             |
| Quote    | Quote-tweet or quote a post with commentary      | $50–$150            |
| Follow   | Follow a specified account                       | $5–$20              |
| Referral | Refer a new user who signs up                    | $5–$15 per referral |

## Setup

Instant Tasks are fully self-serve and launch immediately after funding.

**Step 1 - Details**

* Select task type (Post, Quote, Follow, or Referral)
* Choose target platform (X, TikTok, Instagram, YouTube)
* Write the task brief and any content requirements
* Set campaign duration

**Step 2 - Eligibility** Filter which creators in your Community can participate:

* Minimum follower count
* Quality Score minimum
* Location / region
* Niche or vertical
* Specific creator allowlist

**Step 3 - Budget and reward structure**

* Minimum budget: **$100 USDC**
* Platform fee: **15% of total budget**
* Choose distribution method: FCFS, Raffle, or fixed reward per completion

**Step 4 - Launch** Connect your wallet, confirm the transaction on Base, and the campaign goes live. Creators receive instant Telegram notifications.

## Verification

Airaa verifies each submission automatically:

* Confirms the task was completed on the correct platform
* Checks it was completed by the correct creator account
* Screens for bot activity and low-quality engagement

No manual review required unless a submission is flagged.

## Notes

* Campaigns cannot be paused or cancelled once live
* Unspent budget is withdrawable after 7 days
* Creators receive USDC within 48 hours of verification


# UGC Campaigns

Creators produce brand-briefed short-form videos. You review and approve each video before payment is released.

## When to use UGC

* You need original creative content, not just engagement actions
* You're running awareness or product launch campaigns
* You want a library of brand-approved video assets
* You're targeting TikTok, Instagram Reels, YouTube Shorts, or X video

## How UGC campaigns work

**You provide:**

* A creative brief (talking points, do's and don'ts, example content)
* Brand assets if required (logos, product shots, key messaging)
* Eligibility requirements (follower count, niche, region)
* Budget and per-video rate

**Creators produce:**

* Original short-form video following your brief
* Posted on their own account to their audience
* Submitted through Airaa for review

**Airaa handles:**

* AI quality screening before your review queue
* Payout to approved creators within 48 hours
* Performance tracking (views, engagement) after posting

## Compensation

UGC campaigns typically pay on a **CPM basis** - creators earn based on verified views generated by their content.

Typical range: **$3–$10 CPM** on rolling views over the campaign window.

Fixed per-video rates are also supported for campaigns with specific deliverable requirements.

Typical total earnings per video: **$200–$2,500** depending on the creator's audience size.

## Setup

UGC campaigns are configured through the Campaign App Store. For large or complex briefs, the Airaa team can help structure the campaign. [Contact us →](https://t.me/airaaHQ)

## Review workflow

1. Creator submits content through Airaa
2. AI screening checks for brand safety and brief compliance
3. Flagged content goes to your review queue
4. You approve or reject with optional feedback
5. Approved content is scheduled for payout; creators post on the agreed date


# Clipping

Clipping campaigns take one piece of long-form content and distribute it as short-form clips across your creator community. Efficient content distribution at scale.

## When to use Clipping

* You have a podcast, Space recording, AMA, or long-form video
* You want wide short-form distribution without producing each clip yourself
* You're repurposing an event, keynote, or founder interview
* You want brand-approved clips posted by real creators to real audiences

## How Clipping works

**You provide:**

* The long-form source content (video file, Space recording, podcast episode)
* Clip guidelines (key moments to highlight, duration, messaging)
* Brand assets if required
* Budget

**Creators produce:**

* Short-form clips (typically 30–90 seconds) from the source content
* Submitted for brand approval before posting
* Posted to TikTok, Reels, Shorts, or X

**Airaa handles:**

* Distributing the source content to eligible creators
* AI review of submitted clips for brand compliance
* Payout within 48 hours of approval
* View tracking and performance reporting

## Compensation

Clipping campaigns pay on a CPM basis.

Typical range: **$5–$6 CPM** on verified views.

Typical per-clip earnings: **$5–$30** depending on creator audience size and view performance.

## Setup

Clipping campaigns are self-serve via the Campaign App Store. Upload your source content, write the brief, set eligibility filters, fund, and launch. [Contact Airaa](https://t.me/airaaHQ) for high-volume or priority campaigns.

## Example use cases

* Web3 project repurposing a 2-hour AMA into 60 founder clips
* DTC brand turning a product video into UGC-style testimonial clips
* B2B SaaS distributing a webinar as short educational clips on LinkedIn / X


# Aura Board

A competitive KOL mindshare leaderboard. Top creators compete to generate the most brand-relevant content and engagement, sharing a brand-funded prize pool based on their rank.

## When to use Aura Board

* Pre-token generation event (TGE) mindshare campaigns
* Sustained community engagement over weeks or months
* KOL activation where you want competitive, high-effort content
* Building brand presence in a specific ecosystem or community

## How Aura Board works

**Structure:**

* Creators compete over a defined time period (typically 2–8 weeks)
* Each creator is scored based on content output, engagement, and brand relevance
* Rankings update in real time on a public leaderboard visible to all participants
* At the end of the period, the prize pool is distributed based on final rank

**Scoring:** Scores are weighted across:

* Volume of brand-related content posted
* Engagement generated (reactions, comments, shares, views)
* Content quality (AI-assessed brand relevance and production quality)
* Smart follower influence (followers who are themselves influential)

**Prize pool:** Funded by the brand in USDC on Base. Distribution curve is configured at setup (e.g., top 10 take 70% of pool, next 40 take remaining 30%).

## Setup

Aura Board campaigns require coordination with the Airaa team for configuration. [Reach out on Telegram →](https://t.me/airaaHQ)

The Airaa team will help you:

* Define scoring weights
* Set the campaign duration and prize structure
* Configure eligibility (open to all Community members or curated KOL list)
* Set up the public leaderboard page

## Example structure

| Rank      | Prize          |
| --------- | -------------- |
| 1st       | $5,000 USDC    |
| 2nd       | $3,000 USDC    |
| 3rd       | $2,000 USDC    |
| 4th–10th  | $500 USDC each |
| 11th–50th | $100 USDC each |


# Getting Started

## What you need

<figure><img src="/files/zmmKOIYobzfp72PEYjEQ" alt=""><figcaption></figcaption></figure>

\## What you need

* An active social account on TikTok, Instagram, YouTube, or X
* A Base network wallet (Airaa creates one for you automatically if you don't have one)

## Sign up

Go to [app.airaa.xyz](https://app.airaa.xyz).

Sign up with your email or connect your X account. If you sign up with email, Airaa automatically creates a **Base wallet** linked to your account. You can also connect an existing MetaMask or Coinbase Wallet.

## Connect your platforms

Connect the social accounts you create on. Airaa reads:

* Follower count and follower quality
* Engagement rate and history
* Account age and activity

This data determines your **Quality Score** and your eligibility for campaigns.

You can connect multiple platforms. Each connected platform unlocks additional campaign eligibility.

## Enable Telegram alerts

Activate the Airaa Telegram bot to receive instant notifications when a campaign you're eligible for goes live. High-demand campaigns (especially Instant Tasks on FCFS) fill up quickly - Telegram alerts give you the fastest possible response time.

Find the Telegram bot link in **Account Settings → Notifications**.

## Find Communities

Browse the **Community Directory** in the app. Filter by niche, region, or platform. Apply to Communities that match your content style.

Some Communities are invite-only. If a brand has invited you directly, you'll receive a link - no application needed.

Once approved, you're a permanent member of that Community and will see all its campaigns.

***

* [How payouts work →](/creators/payouts)
* [Understanding your Quality Score →](/creators/quality-scores)


# Payouts

All creator payments on Airaa are made in **USDC on the Base network**, within **48 hours of content approval**.

## How payouts work

<figure><img src="/files/1yyvcDzJt1Z6xUtijXTu" alt=""><figcaption></figcaption></figure>

\## How payouts work

1. You complete a campaign task and submit through the Airaa app
2. Airaa's AI verifies your submission
3. If the campaign requires brand review, the brand approves your content
4. USDC is sent to your linked wallet within 48 hours of final approval

No invoices. No wire transfers. No payment delays.

## Your wallet

**Auto-generated wallet:** If you signed up with email, Airaa automatically created a Base wallet for you. Your USDC is sent there automatically.

**Connected wallet:** If you linked MetaMask or Coinbase Wallet, your USDC goes directly to that wallet.

You can view your wallet address and balance in **Account → Wallet**.

## Withdrawing USDC

USDC on Base can be transferred to any compatible wallet or exchange. To convert to fiat (USD, EUR, etc.), use an exchange that supports Base network USDC (e.g., Coinbase, Binance).

## Payment status

Track all your payments in **Account → Earnings**:

* Pending - submitted, awaiting verification or brand review
* Approved - verification complete, payment processing
* Paid - USDC sent to your wallet
* Rejected - submission did not meet campaign requirements

## Common questions

**What if my submission is rejected?** You won't be paid for rejected submissions. Airaa will show the rejection reason. You can resubmit if the campaign allows revisions.

**What if I don't receive payment after 48 hours?** Contact Airaa support via the in-app chat or [Telegram](https://t.me/airaaHQ).

**Can I change my wallet address?** Yes. Go to **Account → Wallet → Update wallet**. Future payments will go to the new address. Past payments cannot be rerouted.


# Quality Scores

Your **Quality Score**

{% hint style="info" %}
📸 **Image:** Upload a screenshot of the creator profile overview tab showing Smart Followers count, Aura Points, and Total Earned stats.
{% endhint %}

Your **Quality Score** (also called your Aura Score) is Airaa's composite measure of your reliability, audience quality, and content performance. It determines which campaigns you're eligible for and how you rank on Aura Boards.

## What affects your score

| Factor                   | What it measures                                                             |
| ------------------------ | ---------------------------------------------------------------------------- |
| Completion rate          | What % of accepted campaigns you complete and submit on time                 |
| Approval rate            | What % of your submissions brands approve                                    |
| Audience quality         | Smart followers - followers who are themselves influential or highly engaged |
| Engagement rate          | Authentic engagement relative to your follower count                         |
| Account age and activity | How established and consistently active your account is                      |
| Bot screening            | Whether your follower base passes Airaa's bot detection                      |

## How scores accumulate

Your Quality Score builds across every Community you participate in. Completing campaigns, receiving approvals, and delivering on-brief content all increase your score. Missed deadlines, rejected submissions, and bot-inflated metrics lower it.

Scores are not reset between campaigns or between Communities.

## Why your score matters

* **Campaign eligibility** - higher-paying campaigns typically require a minimum Quality Score
* **Priority access** - some brands reserve spots in high-demand FCFS campaigns for high-scoring creators
* **Aura Board ranking** - Quality Score is one of the weighted inputs in leaderboard competition
* **Brand trust** - brands can sort and filter their Community by Quality Score when reviewing creators

## Improving your score

* Complete every campaign you accept
* Follow briefs closely - off-brief content is the most common rejection reason
* Post on time and within the campaign window
* Grow your following organically - artificial followers are detected and penalized
* Stay active across platforms

## Viewing your score

Your current Quality Score is visible on your creator profile at [app.airaa.xyz](https://app.airaa.xyz). You can also see a breakdown by factor and a history of how it has changed over time.


# Overview

Airaa's API provides programmatic access to creator intelligence, campaign leaderboards, and platform analytics. It is designed for brands, agencies, and analytics teams building on top of Airaa's data.

## Available data

| Resource                                    | What it provides                                                    |
| ------------------------------------------- | ------------------------------------------------------------------- |
| [Contributors](/api-reference/contributors) | Creator profiles, engagement metrics, mention history, top rankings |
| [Projects](/api-reference/projects)         | Project intelligence profiles, sentiment, community metrics         |
| [Narratives](/api-reference/narratives)     | Trending narratives with historical momentum                        |
| [Leaderboards](/api-reference/leaderboards) | Custom leaderboards with weighted scoring                           |
| Discovery                                   | Search and filter creators by ecosystem, category, and platform     |

## Access

The API is not publicly available. To request credentials, contact the Airaa team on [Telegram](https://t.me/airaaHQ) or email <api@airaa.xyz>.

API keys are issued per organization. Include your key in all requests as a header:

```
Authorization: Bearer YOUR_API_KEY
```

## Base URL

```
https://api.airaa.xyz/v1
```

## Response format

All responses are JSON. Successful responses return a `data` object. Errors return an `error` object with a `code` and `message`.

```json
{
  "data": { ... }
}
```

```json
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}
```

## Rate limits

Rate limits are enforced per API key. Contact the Airaa team for your specific limits. Exceeding your limit returns a `429 Too Many Requests` response with a `Retry-After` header.

***

* [Authentication →](/api-reference/authentication)
* [Contributors →](/api-reference/contributors)
* [Leaderboards →](/api-reference/leaderboards)


# Authentication

All Airaa API requests require authentication via a Bearer token.

## Getting an API key

API keys are not self-serve. [Contact the Airaa team](https://t.me/airaaHQ) to request access. Keys are issued per organization.

## Making authenticated requests

Include your API key in the `Authorization` header of every request:

```http
GET /v1/contributors HTTP/1.1
Host: api.airaa.xyz
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
```

## Error responses

| Status | Code           | Meaning                                                  |
| ------ | -------------- | -------------------------------------------------------- |
| 401    | `unauthorized` | Missing or invalid API key                               |
| 403    | `forbidden`    | Valid key but insufficient permissions for this resource |
| 429    | `rate_limited` | Request rate exceeded; check `Retry-After` header        |

## Key management

API keys do not expire automatically but can be revoked by the Airaa team on request. Treat your key as a secret - do not expose it in client-side code or public repositories.

To rotate a key, contact <api@airaa.xyz>.


# Contributors

The Contributors API returns creator profiles, engagement metrics, mention history, and top contributor rankings.

## List contributors

```http
GET /v1/contributors
```

Returns a paginated list of creators matching the specified filters.

**Query parameters**

| Parameter           | Type    | Description                                                 |
| ------------------- | ------- | ----------------------------------------------------------- |
| `platform`          | string  | Filter by platform: `tiktok`, `instagram`, `youtube`, `x`   |
| `niche`             | string  | Filter by content niche (e.g., `web3`, `gaming`, `fitness`) |
| `region`            | string  | ISO 3166-1 alpha-2 country code                             |
| `min_followers`     | integer | Minimum follower count                                      |
| `min_quality_score` | number  | Minimum Quality Score (0–100)                               |
| `limit`             | integer | Results per page. Default: 20, max: 100                     |
| `cursor`            | string  | Pagination cursor from previous response                    |

**Example request**

```http
GET /v1/contributors?platform=tiktok&niche=web3&min_followers=10000&limit=20
Authorization: Bearer YOUR_API_KEY
```

**Example response**

```json
{
  "data": [
    {
      "id": "ctr_abc123",
      "handle": "@creatorhandle",
      "platform": "tiktok",
      "followers": 45200,
      "quality_score": 82.4,
      "engagement_rate": 0.064,
      "niche": ["web3", "crypto"],
      "region": "US",
      "mention_count_30d": 14
    }
  ],
  "next_cursor": "eyJpZCI6..."
}
```

## Get a contributor

```http
GET /v1/contributors/{id}
```

Returns the full profile for a single creator including engagement history and mention history.

**Path parameters**

| Parameter | Type   | Description                     |
| --------- | ------ | ------------------------------- |
| `id`      | string | Creator ID (e.g., `ctr_abc123`) |

**Example response**

```json
{
  "data": {
    "id": "ctr_abc123",
    "handle": "@creatorhandle",
    "platform": "tiktok",
    "followers": 45200,
    "quality_score": 82.4,
    "engagement_rate": 0.064,
    "smart_followers": 3800,
    "niche": ["web3", "crypto"],
    "region": "US",
    "mention_history": [
      {
        "date": "2026-05-01",
        "count": 3,
        "brands": ["Brand A", "Brand B"]
      }
    ],
    "top_content": [
      {
        "url": "https://tiktok.com/@creatorhandle/video/...",
        "views": 280000,
        "posted_at": "2026-04-22"
      }
    ]
  }
}
```

## Top contributors

```http
GET /v1/contributors/top
```

Returns the top-ranked creators for a given time window and scoring metric.

**Query parameters**

| Parameter  | Type    | Description                                                         |
| ---------- | ------- | ------------------------------------------------------------------- |
| `metric`   | string  | Ranking metric: `quality_score`, `engagement_rate`, `mention_count` |
| `platform` | string  | Filter by platform                                                  |
| `period`   | string  | Time window: `7d`, `30d`, `90d`                                     |
| `limit`    | integer | Number of results. Default: 10, max: 50                             |


# Projects

The Projects API returns intelligence profiles for web3 projects and brands, including sentiment analysis and community metrics.

## List projects

```http
GET /v1/projects
```

Returns a paginated list of projects.

**Query parameters**

| Parameter   | Type    | Description                                                         |
| ----------- | ------- | ------------------------------------------------------------------- |
| `ecosystem` | string  | Filter by blockchain ecosystem (e.g., `base`, `solana`, `ethereum`) |
| `category`  | string  | Project category (e.g., `defi`, `nft`, `gaming`, `infra`)           |
| `limit`     | integer | Results per page. Default: 20, max: 100                             |
| `cursor`    | string  | Pagination cursor                                                   |

**Example response**

```json
{
  "data": [
    {
      "id": "prj_xyz789",
      "name": "Project Name",
      "ecosystem": "base",
      "category": "defi",
      "sentiment_score": 0.74,
      "community_size": 18400,
      "creator_mention_count_30d": 92,
      "trending": true
    }
  ],
  "next_cursor": "eyJpZCI6..."
}
```

## Get a project

```http
GET /v1/projects/{id}
```

Returns the full intelligence profile for a project.

**Example response**

```json
{
  "data": {
    "id": "prj_xyz789",
    "name": "Project Name",
    "ecosystem": "base",
    "category": "defi",
    "sentiment_score": 0.74,
    "sentiment_trend": "rising",
    "community_size": 18400,
    "creator_mention_count_30d": 92,
    "top_contributors": ["ctr_abc123", "ctr_def456"],
    "narrative_ids": ["nar_001", "nar_002"]
  }
}
```

## Sentiment scores

Sentiment scores range from `-1.0` (highly negative) to `1.0` (highly positive), aggregated from creator content mentioning the project across all connected platforms.


# Narratives

The Narratives API returns trending narratives in the creator ecosystem, with historical momentum tracking. Use it to identify emerging themes and topics before they peak.

## List narratives

```http
GET /v1/narratives
```

Returns trending narratives, ordered by momentum score.

**Query parameters**

| Parameter   | Type    | Description                                     |
| ----------- | ------- | ----------------------------------------------- |
| `ecosystem` | string  | Filter by ecosystem (e.g., `base`, `solana`)    |
| `category`  | string  | Filter by category                              |
| `period`    | string  | Trend window: `24h`, `7d`, `30d`. Default: `7d` |
| `limit`     | integer | Results per page. Default: 20, max: 50          |

**Example response**

```json
{
  "data": [
    {
      "id": "nar_001",
      "label": "AI agents on-chain",
      "momentum_score": 94.2,
      "momentum_trend": "rising",
      "mention_count_7d": 4820,
      "mention_count_change_pct": 38.4,
      "top_platforms": ["x", "tiktok"],
      "related_projects": ["prj_xyz789"]
    }
  ]
}
```

## Get a narrative

```http
GET /v1/narratives/{id}
```

Returns the full profile for a narrative including historical momentum data.

**Example response**

```json
{
  "data": {
    "id": "nar_001",
    "label": "AI agents on-chain",
    "momentum_score": 94.2,
    "momentum_trend": "rising",
    "history": [
      { "date": "2026-05-01", "mention_count": 620, "momentum_score": 78.1 },
      { "date": "2026-05-02", "mention_count": 890, "momentum_score": 85.4 },
      { "date": "2026-05-03", "mention_count": 1240, "momentum_score": 94.2 }
    ],
    "top_contributors": ["ctr_abc123", "ctr_def456"],
    "related_projects": ["prj_xyz789"]
  }
}
```

## Momentum scores

Momentum scores (0–100) reflect the velocity and acceleration of a narrative, not just its raw volume. A score of 90+ indicates a narrative growing significantly faster than baseline activity in that category.


# Leaderboards

The Leaderboards API lets you create and query custom creator leaderboards with configurable scoring weights. Use it to power Aura Boards, internal rankings, or external-facing creator competitions.

## Create a leaderboard

```http
POST /v1/leaderboards
```

**Request body**

```json
{
  "name": "My Campaign Leaderboard",
  "community_id": "com_abc123",
  "start_date": "2026-05-01",
  "end_date": "2026-05-31",
  "weights": {
    "content_volume": 0.3,
    "engagement": 0.4,
    "brand_relevance": 0.2,
    "smart_followers": 0.1
  },
  "platform_filter": ["tiktok", "x"],
  "visibility": "public"
}
```

**Parameters**

| Field             | Type   | Description                      |
| ----------------- | ------ | -------------------------------- |
| `name`            | string | Display name for the leaderboard |
| `community_id`    | string | Your Community ID                |
| `start_date`      | string | ISO 8601 date                    |
| `end_date`        | string | ISO 8601 date                    |
| `weights`         | object | Scoring weights. Must sum to 1.0 |
| `platform_filter` | array  | Platforms to include in scoring  |
| `visibility`      | string | `public` or `private`            |

**Scoring weight options**

| Weight key        | What it measures                                  |
| ----------------- | ------------------------------------------------- |
| `content_volume`  | Number of qualifying posts                        |
| `engagement`      | Total engagement (likes, comments, shares, views) |
| `brand_relevance` | AI-assessed relevance to your brand/brief         |
| `smart_followers` | Influence-weighted follower count                 |
| `quality_score`   | Creator's Airaa Quality Score                     |

## Get leaderboard rankings

```http
GET /v1/leaderboards/{id}/rankings
```

Returns the current ranked list for the leaderboard.

**Example response**

```json
{
  "data": {
    "leaderboard_id": "lb_abc123",
    "updated_at": "2026-05-08T14:22:00Z",
    "rankings": [
      {
        "rank": 1,
        "contributor_id": "ctr_abc123",
        "handle": "@creatorhandle",
        "score": 947.2,
        "content_count": 18,
        "total_engagement": 284000
      },
      {
        "rank": 2,
        "contributor_id": "ctr_def456",
        "handle": "@another",
        "score": 831.6,
        "content_count": 14,
        "total_engagement": 196000
      }
    ]
  }
}
```

## List leaderboards

```http
GET /v1/leaderboards
```

Returns all leaderboards for your organization.

**Query parameters**

| Parameter      | Type    | Description                                 |
| -------------- | ------- | ------------------------------------------- |
| `community_id` | string  | Filter by Community                         |
| `status`       | string  | `active`, `ended`, or `all`. Default: `all` |
| `limit`        | integer | Results per page. Default: 20               |


