Get started quickly with the Buena.ai API using our comprehensive Postman collection. This collection includes all available endpoints with example requests and responses.

Download Collection

Download Postman Collection

Download the latest Postman collection for Buena.ai API

Import Instructions

  1. Open Postman and click the โ€œImportโ€ button in the top left
  2. Choose โ€œLinkโ€ tab and paste the collection URL:
    https://api.buena.ai/postman/collection.json
    
  3. Click โ€œContinueโ€ and then โ€œImportโ€
  4. The collection will appear in your Postman workspace

Alternative: Manual Import

  1. Download the collection file from the link above
  2. In Postman, click โ€œImportโ€ โ†’ โ€œUpload Filesโ€
  3. Select the downloaded JSON file
  4. Click โ€œImportโ€

Environment Setup

After importing the collection, set up your environment variables:
  1. Create a new environment in Postman
  2. Add the following variables:
VariableValueDescription
base_urlhttps://api.buena.ai/api/v2API base URL
api_keyyour-api-key-hereYour Buena.ai API key
  1. Select the environment from the dropdown in the top right

Collection Structure

The Postman collection is organized into the following folders:

๐Ÿ” Authentication

  • API Key Management
  • Key Statistics
  • Key Regeneration

๐Ÿ‘ฅ Lead Management

  • List Leads
  • Create Lead
  • Update Lead
  • Delete Lead

๐Ÿ”— LinkedIn Automation

  • Schedule Actions
  • Upload Prospects
  • Campaign Management

๐Ÿ“Š Enrichment & Prospecting

  • Enrich Leads
  • Prospect Search
  • Data Enhancement

๐Ÿ‘ค User Management

  • User Jobs
  • LinkedIn Integration
  • User Settings

๐Ÿ“ˆ Analytics & Export

  • Campaign CSV Export
  • Usage Statistics
  • Performance Metrics

Pre-request Scripts

The collection includes pre-request scripts that automatically:
  • Set authentication headers
  • Add timestamps to requests
  • Generate request IDs for tracking

Response Examples

Each request includes multiple response examples:
  • โœ… Success responses (200, 201, etc.)
  • โŒ Error responses (400, 401, 403, 404, 429, 500)
  • ๐Ÿ“ Different data scenarios

Testing

The collection includes automated tests for:
  • Response status codes
  • Response schema validation
  • Required fields presence
  • Data type validation

Environment Variables

Here are all the environment variables used in the collection:
{
  "base_url": "https://api.buena.ai/api/v2",
  "api_key": "your-api-key-here",
  "user_id": "user_123",
  "campaign_id": "camp_456",
  "lead_id": "lead_789"
}

Usage Examples

1. Authentication Test

# Test your API key
GET {{base_url}}/health
Headers:
  x-api-key: {{api_key}}

2. Create a Lead

# Create a new lead
POST {{base_url}}/leads
Headers:
  x-api-key: {{api_key}}
  Content-Type: application/json
Body:
{
  "name": "John Doe",
  "email": "john@example.com",
  "company": "Example Corp",
  "title": "CEO"
}

3. LinkedIn Automation

# Schedule a LinkedIn action
POST {{base_url}}/linkedin/schedule-action
Headers:
  x-api-key: {{api_key}}
  Content-Type: application/json
Body:
{
  "prospect_id": "prospect_123",
  "action_type": "connect",
  "message": "Hi {{name}}, I'd love to connect!"
}

Troubleshooting

Common Issues

401 Unauthorized
  • Check that your API key is set correctly in environment variables
  • Ensure the API key is active and not expired
404 Not Found
  • Verify the endpoint URL is correct
  • Check that resource IDs exist
429 Rate Limited
  • Reduce request frequency
  • Implement exponential backoff

Support

If you encounter issues with the Postman collection:
  1. Check our API documentation
  2. Join our Discord community
  3. Contact support at support@buena.ai
The Postman collection is automatically updated when new API endpoints are released. Re-import the collection periodically to get the latest updates.