Saltar al contenido principal

User Account & API Keys

To use the Essentia API, you need a user account and a personal API key. Here’s how to get set up.

Getting Your API Key​

Follow these simple steps to create your account and generate an API key.

  1. Sign Up for an Account: First, create a free user account on our main website.

    Create Your Account

  2. Log In to the Platform: Once your account is created, log in to the Essentia User Platform. This is where you will manage your API keys and credits.

    ➡️ User Platform Login: platform.essentia.upf.edu

  3. Generate Your Key: From your account dashboard on the platform, you can generate one or more API keys.

Keep Your API Key Secret!

Your API key is a secret credential. Do not share it publicly, commit it to version control, or expose it in client-side code.

How Analysis Credits Work​

The Essentia API operates on a credit-based system.

  • Welcome Credits: New user accounts receive a welcome bonus of free credits to help you get started and test the API.
  • Pay-Per-Use: Each algorithm has a different price per second of analyzed audio, adjusted for its computational cost. Your credit balance will be deducted accordingly with each analysis job.
  • Topping Up: You can purchase additional credits through your account dashboard on the user platform. For questions about bulk pricing or custom plans, please contact us.

Rate limits​

We implemented rate limiting to ensure fair usage and system stability for all users. Rate limits may vary based on your plan.

Endpoint-Specific Limits​

Audio Management

  • Upload: 20 files per second per user
  • Stream: 100 requests per second per user

Audio Analysis

  • Batch Job submission (/v1/analysis/job): 200 jobs per second per user
  • Real-time analysis (/v1/analysis/stream): 10 requests per second per user.

When you exceed rate limits, the API returns 429 Too Many Requests.