Profile
Generate AI Profile
Generate an AI-written professional profile summary for the authenticated customer based on their existing profile data.
POST
Generate AI Profile
Documentation Index
Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
Use this file to discover all available pages before exploring further.
Generate AI Profile
Uses OpenAI to generate a professional profile summary for the authenticated customer. The AI drafts theProfileSummary text based on the customer’s existing profile fields (name, position, company, tags, etc.). The portal presents the result for the customer to review and accept before saving it via PATCH /api/public/coworker/profile.
This endpoint requires the location to have the OpenAI integration enabled. If it is not configured, the AI profile button will not appear in the
portal UI.
Authentication
Requires a valid customer bearer token.Request Body
No body is required. The AI uses the customer’s existing profile data from the server session.Response
Returns aCoworker object with the ProfileSummary field populated with the AI-generated text. The customer’s profile is not saved automatically — the customer must review and confirm, after which the portal calls PATCH /api/public/coworker/profile with ProfileSummary.
The AI-generated professional profile summary. May contain Markdown formatting. Presented to the customer for review before saving.
true when AI profile generation is available for this location. Use this to show or hide the “Generate with AI” button.Example Response
TypeScript Integration
Usage in Portal
| Context | Source file |
|---|---|
| Professional profile form — “Generate with AI” button | src/views/user/components/ProfessionalProfile.tsx |
Error Responses
The bearer token is missing, expired, or invalid.
The location does not have the OpenAI integration enabled, or the customer’s profile lacks sufficient data to generate a summary.
Related Endpoints
| Method | Endpoint | Description |
|---|---|---|
PATCH | /api/public/coworker/profile | Save the reviewed AI summary to the customer profile |
GET | /en/profile?_resource=Coworker | Retrieve full customer profile data |
Generate AI Profile