This guide will walk you through authentication, making your first request, and best practices for secure API usage.
Before you begin, ensure you have:
- A Pave account with API access enabled
- A tool for making HTTP requests (cURL, Postman, or a programming language)
- A secure place to store your API credentials
Note: To generate API Keys, make sure to enable the Permission for Admins to be able to generate an API key in the Settings > Roles & Permissions Tab in the Pave App.
Your API key is your authentication credential for all API requests.
- Log into your Pave account
- Navigate to Settings > Connections
- Click Generate API Key
- Important: Copy and save your key immediately - it won't be shown again!
# Your API key will look like this:
3A8F92C4-7B2E-4D6F-9E1C-48DA3F5B8C91_kRmNpXvQ9Hs2wLyTbJfZgUaE5M7CnV4DSecurity Tip: Treat your API key like a password. Never share it publicly or commit it to version control.
Verify your API key is working with a simple ping request:
curl -X GET https://api.pave.com/ping \
-H "x-api-key: YOUR_API_KEY"Expected response:
{
message: "pong"
}Now that you've successfully authenticated and made your first API calls:
- Explore the API Reference for all available endpoints
- Check out Use cases to see how the broader Pave community uses the API
You're ready! Congratulations, you've successfully set up the Pave API and made your first requests. Happy coding!