Skip to main content

​
Base URL

All API requests are made to: 
https://api.guayaba.ai

​
Quick Start

1

Get your API key

Go to the API Keys page in your Guayaba AI dashboard and generate a key. Your key will look like gua_xxxxxxxx_....
2

Make your first request

Try listing your campaigns to verify everything is working:
curl https://api.guayaba.ai/campaigns \
  -H "X-API-Key: gua_a1b2c3d4_your-api-key-here"
3

Add a contact

Once you have a Campaign ID, you can start adding contacts:
curl -X POST https://api.guayaba.ai/contacts \
  -H "Content-Type: application/json" \
  -H "X-API-Key: gua_a1b2c3d4_your-api-key-here" \
  -d '{
    "phoneNumber": "+11234567890",
    "campaignId": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Jane Smith"
  }'

​
What You Can Do

Manage Contacts

Create, list, update, and filter contacts across your campaigns.

Browse Campaigns

Retrieve your campaigns to associate contacts with the right outreach flows.

Authentication

Learn how API key authentication and rate limiting work.

Error Handling

Understand error codes and how to handle them gracefully.