Skip to main content

Quickstart

Get started with the Influship API and make your first successful request in minutes. This guide walks you through the essentials to start finding influencers.

Prerequisites

  • An API key from [email protected]
  • A tool to make HTTP requests (curl, Postman, or code)

Step 1: Get Your API Key

1

Request Access

Contact [email protected] to receive your API key.
2

Store Securely

Save your API key as an environment variable:
export INFLUSHIP_API_KEY="your_api_key_here"
Never commit API keys to version control. Always use environment variables or secrets management.

Step 2: Verify API Access

Test your connection with a health check (no authentication required):
curl https://api.influship.com/health
{
  "ok": true,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Step 3: Test Authentication

Verify your API key works correctly:
curl -X POST https://api.influship.com/v1/search \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"query": "test", "limit": 1}'
✅ If you get results, your API key is working! If you get a 401 error, double-check your API key.

Step 4: Find Influencers

Now let’s use the AI-powered search to find creators:
curl -X POST https://api.influship.com/v1/search \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "fitness creators with high engagement who post about healthy living",
    "limit": 5
  }'
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Sarah Johnson",
      "avatar_url": "https://example.com/avatar.jpg",
      "bio": "Fitness coach and wellness advocate",
      "profiles": [
        {
          "id": "prof_123abc",
          "platform": "instagram",
          "username": "sarahfitness",
          "follower_count": 125000,
          "engagement_rate": 4.5,
          "verified": true
        }
      ],
      "ai_recommendation": {
        "score": 0.92,
        "explanation": "Strong fitness focus with authentic engagement on health topics"
      }
    }
  ],
  "filtered_total": 247,
  "has_more": true,
  "next_cursor": "eyJpZCI6NX0="
}
🎉 Success! You just discovered influencers using AI. Notice how the API explains why each creator matches your query.

Step 5: Get Detailed Creator Information

Enrich creators with full profile data:
curl -X POST https://api.influship.com/v1/creators \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "creator_ids": ["550e8400-e29b-41d4-a716-446655440000"],
    "mode": "detailed",
    "include_profiles": true,
    "profile_mode": "detailed"
  }'
{
  "creators": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Sarah Johnson",
      "avatar_url": "https://example.com/avatar.jpg",
      "bio": "Fitness coach and wellness advocate",
      "profiles": [
        {
          "id": "prof_123abc",
          "platform": "instagram",
          "username": "sarahfitness",
          "follower_count": 125000,
          "engagement_rate": 4.5,
          "verified": true,
          "avg_likes": 5625,
          "avg_comments": 312,
          "posts_per_week": 4.2,
          "avatar_url": "https://instagram.com/avatar.jpg",
          "external_url": "https://sarahfitness.com"
        }
      ]
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Understanding Costs

Every request includes billing information in response headers:
X-Credits-Charged: 2.5
X-Credits-Features: search,detailed
X-Billing-Plan: free
RateLimit-Remaining: 997
  • Search: 2.0 credits per creator + 0.05 credits per social account (detailed mode)
  • Example: 5 creators with detailed profiles = 10 + 2.5 = 12.5 credits
The free tier includes 1,000 credits/month. See Pricing for details.

What You Accomplished

✅ AI Search

Found relevant influencers using natural language

✅ Detailed Profiles

Retrieved comprehensive creator and social account data

✅ AI Insights

Got AI-powered relevance scores and explanations

✅ Real Metrics

Accessed engagement rates and follower counts

Next Steps

Common Workflows

Need Help?