BotForge API

Build custom integrations and extend BotForge functionality with our REST API.

POST /api/chat/:botId

Send a message to a chatbot and receive an AI response.

{
  "message": "Hello, I need help with pricing",
  "session_id": "abc123",
  "metadata": { "user_id": "user_123" }
}

Parameters

FieldTypeDescription
messagestringThe user's message (required)
session_idstringUnique conversation ID (optional)
metadataobjectAdditional context (optional)

GET /api/bots/:botId

Retrieve bot configuration and settings.

{
  "id": "bot_abc123",
  "name": "Sales Bot",
  "status": "active",
  "created_at": "2026-01-15T10:00:00Z"
}

POST /api/webhooks

Register a webhook URL to receive conversation events.

{
  "url": "https://yourapp.com/webhook",
  "events": ["message.received", "conversation.started"],
  "bot_id": "bot_abc123"
}

DELETE /api/bots/:botId/conversations/:sessionId

Delete a conversation history for privacy compliance.

GET /api/analytics/:botId

Retrieve conversation analytics and metrics.

{
  "total_conversations": 1542,
  "avg_response_time_ms": 234,
  "resolution_rate": 0.87",
  "period": "last_30_days"
}

Need API Access?

API access is available on Professional and Enterprise plans.

View Pricing