Embed Configuration

Full reference for all parameters available when embedding the Voice Tutor.

Embed URL

https://tutor.evelynlearning.com/embed?token={SESSION_TOKEN}

Sandbox: https://tutor-sandbox.evelynlearning.com/embed?token=...

Basic Embed

<iframe
  src="https://tutor.evelynlearning.com/embed?token=YOUR_JWT_TOKEN"
  width="100%"
  height="700"
  allow="microphone; camera"
  frameborder="0"
></iframe>

JWT Token Parameters

These parameters are included in the JWT payload signed with your API Secret:

Parameter	Type	Required	Description	Example
`partner_id`	string	Required	Your partner identifier	`"algerian-bac"`
`student_id`	string	Required	Your internal student ID (for analytics and data retrieval)	`"stu_abc123"`
`student_name`	string	Optional	Student's first name (used in conversation)	`"Ahmed"`
`subject`	string	Required	Subject code (math, science, ela, cs, etc.)	`"math"`
`topic`	string	Optional	Topic ID from taxonomy or custom curriculum module	`"algebra-2"`
`level`	string	Required	Grade level (K-2, 3-5, 6-8, 9-10, 11-12, AP, college)	`"11-12"`
`session_goal`	string	Optional	practice, homework-help, concept-review, test-prep, catch-up, challenge	`"test-prep"`
`engine`	string	Optional	Voice engine tier: "standard" or "premium" (default: "standard")	`"standard"`
`locale`	string	Optional	BCP 47 locale code for voice language (default: en-US)	`"ar-DZ"`
`input_mode`	string	Optional	"voice" (default) or "text"	`"voice"`
`voice`	string	Optional	Voice selection (coral, shimmer, alloy, ash, ballad, echo, sage, verse)	`"coral"`
`curriculum_module`	string	Optional	ID of custom knowledge module to load	`"algerian-bac-math-2026"`
`branding`	object	Optional	Visual customization: { primary_color, logo_url, product_name }	`{ "primary_color": "#1E40AF", "product_name": "BAC Tutor" }`
`max_duration_minutes`	number	Optional	Session time limit for cost control (default: unlimited)	`30`
`features`	object	Optional	Enable/disable: homework_upload, text_mode, voice_mode	`{ "homework_upload": true }`
`metadata`	object	Optional	Arbitrary key-value pairs passed through to webhooks	`{ "class_id": "math-11b" }`

Engine Selection

The engine parameter selects the voice engine tier:

Value	Name	Latency	Price/Min
`standard`	Standard	~1.5s	$0.06
`premium`	Premium	<400ms	$0.25

Sandbox environments are limited to the Standard engine. Premium is available in production.

Branding Object

The optional branding object customizes the tutor's appearance:

Parameter	Type	Description
`primary_color`	string	Hex color for buttons and accents
`logo_url`	string	URL to your logo (displayed in tutor header)
`product_name`	string	Replaces "Evelyn Voice Tutor" in the UI

Features Object

Toggle individual features on or off:

Parameter	Type	Description
`homework_upload`	boolean	Enable photo upload for homework problems (default: true)
`text_mode`	boolean	Allow students to switch to text input (default: true)
`voice_mode`	boolean	Allow voice input (default: true)

Example: Full Token

JWT payload

{
  "partner_id": "algerian-bac",
  "student_id": "stu_abc123",
  "student_name": "Ahmed",
  "subject": "math",
  "topic": "algebra-2",
  "level": "11-12",
  "session_goal": "test-prep",
  "engine": "standard",
  "locale": "ar-DZ",
  "branding": {
    "primary_color": "#1E40AF",
    "logo_url": "https://partner.com/logo.png",
    "product_name": "BAC Tutor"
  },
  "curriculum_module": "algerian-bac-math-2026",
  "max_duration_minutes": 30,
  "features": {
    "homework_upload": true,
    "text_mode": true
  },
  "metadata": {
    "class_id": "math-11b",
    "teacher_id": "tch_456"
  },
  "exp": 1735689600
}