Back to Home
CodeNameZee API

Developer Documentation

Integrate CodeNameZee into custom portals, CRM listings, or inject your dynamic floating real estate bubble programmatically.

Platform Ingestion APIs

CodeNameZee provides secure REST JSON endpoints. All routes return structured payloads. Custom chatbot styling, system settings, and lead alerts configured in the dashboard reflect automatically in both widget embeddings and API responses.

Base URL: https://api.codenamezee.com

GETWidget Injection Bubble

To load the customized chatbot bubble on any external domain (WordPress, Wix, Webflow, custom HTML), append this script in the footer or header code. The service delivers a CORS-optimized bundle compiled specifically for your agent configurations.

HTML script tag
<script 
  src="https://api.codenamezee.com/api/widget/bot_8f39b1a0c4" 
  async 
  defer>
</script>

POST/api/chat

Send visitor queries to trigger similarity lookups on the chatbot's knowledge chunks and invoke OpenAI's completions engine. Accommodates conversation transcripts to preserve thread memory context.

cURL request
curl -X POST https://api.codenamezee.com/api/chat \
  -H "Content-Type: application/json" \
  -d '{
    "botId": "bot_8f39b1a0c4",
    "message": "Do you have any 4,500 Sq Ft villas in Westlake?",
    "history": [
      { "sender": "bot", "text": "Welcome to Premium Realty! How can I help?" }
    ]
  }'
Parameters & Schemas
botIdString (Required). The UUID code identifying your chatbot profile.messageString (Required). The incoming visitor prompt.historyArray (Optional). List of previous dialogues to feed thread context.

POST/api/leads

Triggered automatically once a visitor inputs contact qualifiers. Persists details in the agency leads directory, updates dashboard widgets, and triggers the Twilio dispatch routing to send real-time alerts.

cURL request
curl -X POST https://api.codenamezee.com/api/leads \
  -H "Content-Type: application/json" \
  -d '{
    "botId": "bot_8f39b1a0c4",
    "name": "David Miller",
    "phone": "+15125551234",
    "email": "david@example.com",
    "notes": "Budget: 2.5 Million USD. Looking for immediate viewing."
  }'

POST/api/train

Train your bot asynchronously. Submitting a listing page link or brochure texts initiates automated crawling/parsing and chunks text strings before embedding into pgvector.

cURL request
curl -X POST https://api.codenamezee.com/api/train \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "botId": "bot_8f39b1a0c4",
    "sourceType": "url",
    "sourceData": "https://premiumrealty.com/listings/westlake-villa"
  }'
Headers Required
AuthorizationBearer YOUR_API_KEY. Generate developer credentials inside Account Settings.Content-Typeapplication/json