Authentication

To interact with the Hypercode API endpoints, you'll need to authenticate your requests. This guide offers a brief walkthrough on implementing authentication effectively.

API Key

The primary method to authenticate your requests with the Hypercode API is through an API Key. To get started, create an API key within the Hyper application. Navigate to the API Key settings to generate your unique key.

Once you have your API key, incorporate it into the request header to authenticate your API calls. Below is an example demonstrating how to do this using cURL:

Example request with an API key

curl -X POST https://api.gethyper.ai/v1/search \
  -H "Authorization: Bearer {your_api_key}" \
  -H "Content-Type: application/json" \
  -d '{"query": "Foo product roadmap"}'

In the example above, replace {your_api_key} with the actual API key you generated. Ensure that you keep your API key confidential. If there's any possibility that it has been compromised, reset it immediately to maintain security.