Authentication

All API requests require a bearer token. This page covers how to create your key and use it in requests.

Create Your API Key

1. Go to your Profile Settings.
2. Scroll to the API Key section.
3. Click Create API Key.
4. Copy the key immediately. It is only displayed once.

Key Format

User-level API keys use the prefix:

optiuser_v1_

Organization-level keys are coming soon and will use a different prefix.

Using Your Key

Include the key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

Example Request (cURL)

curl -X GET "https://api.optiverse.ai/external-api/v1/list-records" \
  -H "Authorization: Bearer optiuser_v1_your_key_here"

Example Request (JavaScript)

const response = await fetch("https://api.optiverse.ai/external-api/v1/list-records", {
  headers: {
    "Authorization": "Bearer optiuser_v1_your_key_here"
  }
});

const data = await response.json();

Example Request (Python)

import requests

headers = {"Authorization": "Bearer optiuser_v1_your_key_here"}
response = requests.get(
    "https://api.optiverse.ai/external-api/v1/list-records",
    headers=headers
)

data = response.json()

Security Best Practices

• Never commit API keys to version control. Use environment variables or a secrets manager.
• Rotate keys periodically. Delete and recreate keys if you suspect a leak.
• Limit access. Only share keys with systems that need them. Each user should use their own key.

Error Codes

Rate Limits

The current rate limit is one request per 3 minutes for polling use cases. Contact support@optiverse.ai for higher throughput.