Authentication

The Guavy API uses API keys to authenticate requests. This guide will walk you through the steps to obtain your API key, install the necessary client libraries, and make your first authenticated API call.

Get Your API Key

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

↳ Navigate to the API request form and fill out each field.
↳ If you already have an API key listed to use for your application, simply copy it.

Install the Client Library for Your Language

Since the Guavy API is a RESTful API, you can use any HTTP client library to make requests to the API.

There's no SDK to install. Guavy is plain REST, so any client works: curl, Python requests, Node fetch, or your framework's built-in HTTP 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 demonstrates how to make an authenticated API request using cURL. All Guavy API endpoints require authentication via a Bearer token, which should be included in the Authorization header. This token identifies your account and determines your access level to various endpoints.

To use this example:

Replace YOUR-GUAVY-ACCESS-TOKEN with your personal API key from the Guavy dashboard
The URL includes the specific endpoint path shown in the documentation
All requests use HTTPS for secure data transmission

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.

To test that you have everything set up correctly, we'll make a simple request to the ping endpoint. Hitting this endpoint acts as a health check on the Guavy API service; it costs a single token.

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