Benji API Documentation

POST

/api/send-compliment

Generates a Benji compliment and returns a redeemable QR code

Headers

Name Required Description
X-API-Key Yes Your API authentication key

Request Body

Parameter Type Description
compliment_text string The compliment message to send
animation_name string Name of the animation to display with the compliment

Success Response (201)

            {
                "message": "Compliment sent successfully",
                "qr_code_image": "base64_encoded_qr_code_string"
            }

Error Response (404)

            {
                "error": "User not found"
            }

Features

  • Generates unique redemption code
  • Creates QR code for easy sharing
  • Sends notifications via push, email (if enabled)
  • Supports custom animations
POST

/api/send-gifts

Send physical gifts, flowers, and personalized messages to users

Headers

Name Required Description
X-API-Key Yes Your API authentication key

Request Body

Parameter Type Required Description
complimentText string Yes Message to include with the gift
private boolean Yes Whether to send anonymously
extrasMap object Yes Map of product IDs to quantities
animation string No Animation name to display
giftCard number No Honey Drops gift card amount
postcardMessage string Yes Message for physical postcard
imageIndex number Yes Index of postcard template
userId string No* Recipient user ID (if sending to existing user)

Shipping Information (Required if userId not provided)

Parameter Type Description
fullName string Recipient's full name
streetAddress string Primary street address
streetAddress2 string Secondary address line (optional)
zipCode string Postal/ZIP code
city string City name
state string State/Province
country string Country name

Success Response (201)

            {
                "success": true
            }

Error Response (400)

            {
                "error": "Insufficient Honey Drops"
            }

Features

  • Physical gift delivery with tracking
  • Digital gift cards
  • Custom animations
  • Personalized postcards with QR codes
  • Anonymous gifting option
  • Automatic notifications via email and push
  • Virtual flower garden integration
POST

/api/send-wingbear-dm

Benji sends personalized direct messages with optional video animations

Request Body

Parameter Type Description
username string Recipient's username
message string Custom message (optional - AI generates if not provided)
is_video boolean Whether to generate video animation
animation string Animation for video
amount integer Amount of honey gifted to the person if they replied

Success Response (200)

            {
                "status": "Message sent successfully for review",
                "redeem_code": "XXXX-XXXX",
                "message": "Your message content here"
            }
POST

/api/send-tax-collection

Send payment collection messages with optional video animations for 1 honey drop (Extra 1 honey drop for video)

Request Body

Parameter Type Description
owing string Name of person who owes
owed-amount string Amount owed
owe-reason string Reason for the debt
ower-phone-number string Phone number to send message
payment-details string Payment method
collection boolean Whether to send as video
animation string Animation to send with video

Success Response (200)

            {
                "success": "Video sent successfully"
            }
POST

/api/check-for-redflags

Analyze Instagram profile screenshots for potential relationship red flags using AI vision for 1 honey drop

Headers

Name Required Description
X-API-Key Yes Your API authentication key

Request Body

Parameter Type Description
handle string Instagram account handle
screenshot string Base64 encoded image of the Instagram profile

Success Response (200)

                    {
                        "summary": "Analysis of profile red flags",
                        "score": 7.5,
                        "created_date": "2024-01-20"
                    }

Error Responses

Status Response Description
400 {"error": "Not enough honey"} Insufficient honey drops balance
500 {"error": "Operation failed after multiple attempts."} Service temporarily unavailable
POST

/api/phone-surge

Schedule automated message sequences to a phone number for 1 honey drop for 3 or 4 messages, 2 for 6 or 7, and 3 for 9 or 10

Request Body

Parameter Type Default Description
start_time string Required ISO format datetime for message sequence start
duration integer 30 Duration in minutes for message sequence
phone_number string "" Target phone number
type string "random" Message sequence type
messages_number integer 6 Number of messages in sequence (Possible values: 3,4,6,7,9,10)

Success Response

                    {
                        "status": "success",
                        "message": "Message scheduled successfully.",
                        "id": "schedule_id"
                    }
POST

/api/send-date-queues

Schedule date-related message sequences with optional notifications for 1 honey drop for 3 or 4 messages, 2 for 6 or 7, and 3 for 9 or 10

Request Body

Parameter Type Default Description
start_time string Required ISO format datetime for sequence start
duration integer 30 Duration in minutes
phone_number string "" Target phone number (optional)
messages_number integer 6 Number of messages

Features

  • Timezone-aware scheduling
  • Flexible message sequence configuration
  • Optional notification mode when no phone number provided
  • Automatic honey drops deduction
  • Success tracking via API calls

Error Response

                    {
                        "error": "Not enough honey"
                    }