Skip to main content

Create Projects

This tutorial walks you step by step through creating a new project in the Sociovite API.

Prerequisites​

  • ✅ A valid Sociovite account
  • ✅ An API client (Postman, curl, or any HTTP tool)

Step 1: Log in and get a token​

First, log in to obtain your authentication token.

Token example

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Store this token securely. You will use it for authorization in the next steps.

📖 See full Auth API documentation

Step 2: Create a new project​

After logging in, use your token to create a new project. In this step, you define:

  • The keywords you want to monitor
  • The date range for the posts to collect

📖 See full project creation docs

Project ID example

note: Project ID is the same as Keyword ID

{
  "id": "proj_abc123def456"
}

Keep the returned id (for example proj_abc123def456); you will need it in later steps.

📖 See full Project API documentation

Step 3: Start keyword scraping​

Once the project is created, use the project ID to start the keyword scraping process.

If the job is started successfully, you will receive a response similar to:

{
  "result": "string",
  "success": true
}

📖 See full AI Service documentation

🎉 All done​

Your project has been created and keyword scraping has been started. From here you can:

  1. View mentions using GET /api/mentions
  2. Check usage quota using GET /api/user-quota
  3. Change listen status using PATCH /api/project/listen-status
  4. Get a summary using GET /api/project/summary/{keywordID}

Tips & Best Practices​

Monitoring your quota​

  • Check your quota regularly with GET /api/user-quota
  • Rate limit: 5 requests per second with a burst of 100
  • TTL: 120 seconds per window

Scraping optimization​

  • Limit the number of keywords per request for better performance
  • Use a specific date range to control volume and cost
  • Monitor processing time to fine-tune your workflow

Troubleshooting​

Common Issues​

401 Unauthorized

  • Make sure the token is still valid

  • Check the header format:

    Authorization: Bearer YOUR_TOKEN

429 Too Many Requests

  • Wait a few seconds before the next request
  • Implement retry logic with exponential backoff

500 Internal Server Error

  • Check the request body format
  • Make sure project_id is valid
  • Verify the keywords and platforms you are sending