Authentication

The Guavy API authenticates every request with an API key. This guide covers getting your key, sending it with a request, and making your first authenticated call.

Get Your API Key

The only way to authenticate a request to the Guavy API is with an API key.

↳ New to Guavy? Start free with your email address. Your API key is on your dashboard as soon as you sign in.
↳ Already have an account? Sign in and copy your key from the dashboard.

Use Any HTTP Client

There's no SDK to install. Guavy is plain REST over HTTPS, so any HTTP client works: curl, Python requests, Node fetch, or your framework's built-in client.

Authentication is a single header, Authorization: Bearer YOUR_API_KEY. No request signing and no OAuth required.

Make Your First API Call

The example below makes an authenticated request with cURL. Every Guavy data endpoint needs your API key as a Bearer token in the Authorization header. The key identifies your account and the token budget each call is charged to.

To use this example:

Replace YOUR-GUAVY-ACCESS-TOKEN with your API key from the Guavy dashboard.
The URL is the endpoint path shown on each reference page.
Every request uses HTTPS.

curl \
--request GET \
--url     'https://guavy.com/api/v1/ping' \
--header 'Authorization: Bearer YOUR-GUAVY-ACCESS-TOKEN' \
--header 'Content-Type: application/json'

This request format works across all modern HTTP clients, including Python requests, JavaScript fetch, and other programming language libraries.

The example calls the ping endpoint, a health check that confirms your key works. It costs one token.

If everything is set up correctly, the request to ping returns the JSON pong message as a response.