Endpoints

Complete reference for the BotPhi REST API.

The BotPhi API is a RESTful JSON API. All endpoints are relative to the base URL: https://api.botphi.app/v1

Bots

List all bots

GET /v1/bots

{
  "data": [
    {
      "id": "bot_abc123",
      "name": "support-bot",
      "status": "running",
      "model": "gpt-4o",
      "region": "ap-south-1",
      "created_at": "2026-01-15T10:30:00Z"
    }
  ],
  "has_more": false
}

Create a bot

POST /v1/bots

{
  "name": "support-bot",
  "model": {
    "provider": "openai",
    "model": "gpt-4o"
  },
  "system_prompt": "You are a helpful assistant."
}

Get a bot

GET /v1/bots/:bot_id

Update a bot

PATCH /v1/bots/:bot_id

{
  "system_prompt": "Updated system prompt."
}

Delete a bot

DELETE /v1/bots/:bot_id

Deleting a bot is permanent and will immediately stop serving all connected channels.

Deployments

Deploy a bot

POST /v1/bots/:bot_id/deploy

Get deployment status

GET /v1/bots/:bot_id/deployments/:deployment_id

List deployment history

GET /v1/bots/:bot_id/deployments

Messages

Send a message

Send a message directly to a bot via the API (useful for custom integrations):

POST /v1/bots/:bot_id/messages

{
  "content": "Hello, I need help with my order.",
  "user_id": "user_123",
  "session_id": "session_abc"
}

{
  "id": "msg_xyz789",
  "content": "I'd be happy to help with your order! Could you share your order number?",
  "role": "assistant",
  "tokens_used": 42,
  "latency_ms": 850
}

Authentication

Webhooks