Project Configuration

Once you have an account, you can create and configure your project (Site).

Create a Project

To create a new project, use the POST /api/visitors/sites endpoint.

Endpoint

POST /api/visitors/sites

Request Body

{
  "name": "My Awesome Project",
  "domain": "example.com"
}

• name (required): The name of your project.
• domain (optional): The domain associated with your project.

Response

The API returns the created site object, including the site_id (UUID), which you will need for subsequent requests.

Setup Project

After creating the project, you can initiate the setup process using POST /api/site/setup. This configures various modules like analytics, chat, and leads.

Endpoint

POST /api/site/setup

Request Body

{
  "site_id": "your-site-uuid",
  "setup_type": "complete",
  "options": {
    "enable_analytics": true,
    "enable_chat": true,
    "enable_leads": true,
    "enable_email_tracking": true,
    "default_timezone": "UTC",
    "default_language": "en"
  }
}

• site_id (required): The UUID of the site created in the previous step.
• setup_type: Configuration level (basic, advanced, or complete).
• options: Specific feature toggles and settings.

Update Site Settings

You can update detailed site settings using the POST /api/agents/tools/updateSiteSettings endpoint.

Endpoint

POST /api/agents/tools/updateSiteSettings

Request Body

{
  "site_id": "your-site-uuid",
  "about": "Company description...",
  "industry": "Technology",
  "company_size": "11-50",
  "branding": { ... },
  "customer_journey": { ... },
  "products": [ ... ],
  "services": [ ... ],
  "goals": { ... }
}

This endpoint allows you to provide comprehensive information about your company, which helps agents understand your business context.