Get your token

AI settings

You can customize the AI assistant by adding instructions and prompts. To do that:

1. Sign in to the Prose Captain admin panel
2. Go to the "Artificial Intelligence Settings" section.
3. In the "Prompt Template" section you can tailor instructions for your assistant
4. Enter instructions that define what the assistant should know and how it should communicate
5. Save your changes using the "Save" button

Language preferences

Prose Captain supports multiple languages from the admin panel. To set your preferred language:

1. Sign in to the admin panel
2. Open the "Widget Settings" section
3. Choose your preferred language from the available options (e.g. Polish or English)
4. Save your preferences

That language is used in the widget UI and influences the assistant default reply language.

Adding the script

Paste the following snippet in your page <head> head section:

<script
    src="https://widget-api.example.com/embed.js"
    data-widget-token="YOUR_TOKEN_HERE"
    data-theme="light" 
></script>

Script parameters

3.1. User context

When you start a new chat session you can send user context so the assistant better understands needs and tailors replies. Context may include:

• User data (e.g. first name, user id)
• Information about the current page or category
• Preferences and interests
• Browsing history
• Other custom data fields

To send user context, add a context property to the JSON body when creating a new session:

// Sample user context object
const userContext = {
  user_id: "user_12345",         // Prefer an opaque ID instead of full PII
  first_name: "Alex",             // First name only, not a full legal name
  viewed_categories: ["footwear", "sport", "electronics"],
  current_page: "Category: Sports",
  preferences: {
    favorite_colors: ["blue", "green"],
    interests: ["running", "mountain biking", "photography"]
  },
  visit_history: {
    last_visit: "2023-09-15T14:30:00Z",
    visit_count: 12
  }
};

When creating a new session, include that object in the request body:

// Create a new session with user context
fetch('https://widget-api.example.com/api/widget/thread?token=YOUR_TOKEN_HERE', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    context: userContext
  })
})
.then(response => response.json())
.then(data => {
  console.log('Session created:', data.session_id);
});

Authentication

All Article API endpoints require a Directus Bearer token in the Authorization header:

Authorization: Bearer YOUR_DIRECTUS_TOKEN

Get your token from the Directus admin panel under User Settings → Token.

Base URL: https://widget-api.example.com