Cor’s AI agent. Obi works alongside each customer. It learns their goals, builds a personalized plan, sees their screen to guide them, and executes actions to get things done. In code you will see it as
ObiSDK and obiWidgetConfig.An end user who is being onboarded, one of your customers. In the SDK you describe an onboardee with the
user object. In the APIs an onboardee has its own onboardee_uuid and is also identified by email.A guided onboarding flow. A plan has a
uuid and a name like “Getting Started”. You can start a specific plan from code with startSession and its planUuid.You may also see a plan called a course. They mean the same thing. We use plan everywhere in these docs.
One run of a plan by an onboardee. A session has a status (for example
completed), a start and finish time, a duration, a summary, and optional feedback. Sessions are what you list and report on through the Session Reporting API.The full conversation from a session, stored as a JSON file. You do not get the transcript inline. You request a short-lived download URL from the transcript endpoints, then fetch the file. URLs are valid for 1 hour.
Extra information about an onboardee that helps Obi personalize sessions. You can set context two ways: client-side through the SDK
user object, or server-side through the User Context API.
