keyAuthentication

To use the VibeMap Developer API from your server or external applications, you need a Personal Access Token.

Generating a Token

Currently, Personal Access Tokens can be managed through the VibeMap Dashboard.

  1. Navigate to Account Settings -> API Keys.

  2. Click on "Generate New Token".

  3. Give your token a descriptive name (e.g., "GitHub Actions" or "Production Server").

  4. Copy your token immediately. It will only be shown once for security reasons.

Token Format

VibeMap Personal Access Tokens always start with the prefix vm_ followed by a unique alphanumeric string.

Example: vm_7a8b9c0d1e2f3g4h5i6j7k8l9m0n

Using Your Token

Include your token in the Authorization header of every request:

curl -X GET "https://vibemap.ai/api/crud/projects" \
     -H "Authorization: Bearer YOUR_PERSONAL_ACCESS_TOKEN"

Token Security

  • Keep it secret: Treat your Personal Access Token as you would a password. Never commit it to version control.

  • Environment Variables: Store your tokens in environment variables (VIBEMAP_API_KEY) on your servers.

  • Revocation: If you believe your token has been compromised, revoke it immediately in the VibeMap Dashboard and generate a new one.

Rate Limits

While we don't strictly enforce hard rate limits for standard usage, we monitor API traffic for abuse. If you plan to make high-volume requests (more than 100 requests per minute), please contact support.

Last updated

Was this helpful?