Projects API

Manage your projects programmatically. Each project represents one bot/business.

List Projects

GET /v1/projects

Returns all projects in your account.

Response:

{
  "projects": [
    {
      "id": "my-company-support",
      "name": "My Company Support",
      "config": { ... },
      "created_at": "2025-01-15T10:00:00Z",
      "updated_at": "2025-03-20T14:30:00Z"
    }
  ]
}

Get Project

GET /v1/projects/:id

Returns a single project with its full configuration.

Update Project

PUT /v1/projects/:id

Update project settings including bot persona, AI model, modules, and channel configuration.

Request body:

{
  "config": {
    "instructions": {
      "persona": "You are a friendly support agent for My Company..."
    },
    "ai": {
      "primary": {
        "provider": "openai",
        "model": "gpt-4"
      }
    },
    "modules": {
      "freshdesk": {
        "enabled": true
      }
    },
    "channels": {
      "telegram": { "enabled": true },
      "jivo": { "enabled": true }
    }
  }
}

Dashboard Stats

GET /v1/stats/dashboard

Returns aggregated statistics across all projects:

Total projects
Active conversations
Messages today
Total messages