Appearance
Personal Profile Endpoints
Manage the authenticated user's Personal Intelligence Profile — sensitivity settings, personal terms, and onboarding state.
Authentication
All endpoints require a valid bearer token. Operations are scoped to the authenticated user's profile.
Get Personal Profile
Retrieve the current user's Personal Intelligence Profile.
GET /api/intelligence-profiles/personalResponse
json
{
"user_id": "usr_abc123",
"sensitivity_dial": "balanced",
"onboarding_dismissed": false,
"term_count": 12,
"effective_sensitivity": "balanced",
"company_floor": "balanced",
"created_at": "2026-01-05T09:00:00Z",
"updated_at": "2026-02-20T16:45:00Z"
}| Field | Type | Description |
|---|---|---|
user_id | string | User identifier |
sensitivity_dial | string | User's chosen sensitivity: relaxed, balanced, paranoid |
onboarding_dismissed | boolean | Whether the user has completed or dismissed onboarding |
term_count | number | Number of personal terms registered |
effective_sensitivity | string | Resolved sensitivity after applying the company floor |
company_floor | string | Organization's Sensitivity Floor setting |
created_at | string | Profile creation timestamp (ISO 8601) |
updated_at | string | Last modification timestamp (ISO 8601) |
Update Personal Profile
Update the user's sensitivity settings.
PUT /api/intelligence-profiles/personalRequest
json
{
"sensitivity_dial": "paranoid"
}| Field | Type | Required | Description |
|---|---|---|---|
sensitivity_dial | string | No | relaxed, balanced, or paranoid |
Response
Returns the updated profile (same schema as GET).
Sensitivity Floor
If the organization's Sensitivity Floor is higher than your chosen setting, effective_sensitivity will reflect the floor value, not your dial setting.
Delete Personal Profile
Remove the user's Personal Intelligence Profile entirely. This deletes all personal terms and resets sensitivity settings to the company baseline.
DELETE /api/intelligence-profiles/personalResponse
Status: 204 No Content
WARNING
This action is irreversible. All personal terms and settings are permanently deleted.
Dismiss Onboarding
Mark the onboarding flow as dismissed so it is no longer shown.
POST /api/intelligence-profiles/personal/dismiss-onboardingResponse
json
{
"onboarding_dismissed": true
}List Personal Terms
Retrieve the user's personal sensitive terms.
GET /api/intelligence-profiles/personal/termsParameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
category | query | string | No | Filter by category |
page | query | number | No | Page number (default: 1) |
per_page | query | number | No | Items per page (default: 50, max: 200) |
Response
json
{
"terms": [
{
"id": "pterm_r7s8t9",
"term": "Project Nightingale",
"category": "project_codename",
"sensitivity": "high",
"created_at": "2026-02-10T11:00:00Z"
},
{
"id": "pterm_u1v2w3",
"term": "Jane Prospect",
"category": "customer_name",
"sensitivity": "medium",
"created_at": "2026-02-14T09:30:00Z"
}
],
"total": 12,
"page": 1,
"per_page": 50
}Add Personal Term
Register a new personal sensitive term.
POST /api/intelligence-profiles/personal/termsRequest
json
{
"term": "Project Nightingale",
"category": "project_codename",
"sensitivity": "high"
}| Field | Type | Required | Description |
|---|---|---|---|
term | string | Yes | Word or phrase to detect (case-insensitive) |
category | string | Yes | Classification category |
sensitivity | string | No | low, medium, high, critical — defaults to category default |
Response
json
{
"id": "pterm_r7s8t9",
"term": "Project Nightingale",
"category": "project_codename",
"sensitivity": "high",
"created_at": "2026-02-25T10:00:00Z"
}Status: 201 Created
Delete Personal Term
Remove a personal term.
DELETE /api/intelligence-profiles/personal/terms/{termId}Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
termId | path | string | Yes | Personal term ID to delete |
Response
Status: 204 No Content
Get Merged Terms
Retrieve the effective term list combining company and personal terms. Company term details are appropriately scoped — the user sees that a company term exists and its category, but sensitive metadata is redacted.
GET /api/intelligence-profiles/merged-termsParameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
category | query | string | No | Filter by category |
page | query | number | No | Page number (default: 1) |
per_page | query | number | No | Items per page (default: 50, max: 200) |
Response
json
{
"terms": [
{
"id": "term_x1y2z3",
"term": "Project Falcon",
"category": "project_codename",
"sensitivity": "critical",
"source": "company",
"created_at": "2026-01-10T08:00:00Z"
},
{
"id": "pterm_r7s8t9",
"term": "Project Nightingale",
"category": "project_codename",
"sensitivity": "high",
"source": "personal",
"created_at": "2026-02-10T11:00:00Z"
}
],
"total": 54,
"page": 1,
"per_page": 50,
"company_term_count": 42,
"personal_term_count": 12
}| Field | Type | Description |
|---|---|---|
source | string | company or personal — indicates which profile owns the term |
company_term_count | number | Total company terms in the merged set |
personal_term_count | number | Total personal terms in the merged set |
Error Responses
| Status | Description |
|---|---|
400 | Invalid request body or parameters |
401 | Missing or invalid authentication token |
404 | Profile or term not found |
409 | Duplicate term |
422 | Validation error (e.g., invalid category) |
json
{
"error": "not_found",
"message": "Personal Intelligence Profile not found. Complete onboarding to create one.",
"status": 404
}