Skip to main content

​
Welcome to amber API

Welcome to the beta version of amber’s public REST API. This API provides programmatic access to amber’s core functionality, allowing you to integrate our search capabilities into your applications.
This is a beta version of our API. We are actively developing and extending the available endpoints. Some features may change as we continue to improve the API.

​
Authentication

The amber API supports two authentication methods: The simplest way to authenticate is using an API key. You can generate your API key directly in the amber UI under your user profile settings.
Quick Start: Create your API key directly in the amber UI:
  1. Log in to amber
  2. Navigate to your user profile
  3. Go to API Keys section
  4. Generate a new API key

​
2. OAuth 2.0 Authentication (For Third-Party Applications)

For third-party applications that need to access amber on behalf of users, we support OAuth 2.0 Authorization Code Grant flow.
OAuth 2.0 requires development effort on the customer side to implement the authorization flow. This method is recommended for:
  • Third-party integrations
  • Multi-user applications
  • Applications that need delegated access

OAuth 2.0 Documentation

Learn how to implement OAuth 2.0 authentication

​
Base URL

All API endpoints are relative to the base URL:

​
Rate Limits

To ensure fair usage and optimal performance for all users, our API implements rate limiting. Specific rate limits will be provided with your API key.

​
Support

If you encounter any issues or have questions about using the API, please contact our support team. We’re here to help you make the most of amber’s capabilities.

API Reference

View the complete API reference