curl --request PATCH \
--url https://paradigm.lighton.ai/api/v3/users/me \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_instructions": "<string>",
"skip_help_step": true,
"terms_accepted": true
}
'import requests
url = "https://paradigm.lighton.ai/api/v3/users/me"
payload = {
"agent_instructions": "<string>",
"skip_help_step": True,
"terms_accepted": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({agent_instructions: '<string>', skip_help_step: true, terms_accepted: true})
};
fetch('https://paradigm.lighton.ai/api/v3/users/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"has_usable_password": true,
"email_verified": true,
"roles": [
"<string>"
],
"persona": "integrate",
"channel": "api",
"profile": {
"id": 123,
"username": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"display": "<string>"
},
"company": {
"id": 123,
"name": "<string>",
"tier": "free",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"login_method": "password",
"ldap_logout_url": "<string>",
"group": {
"id": 123,
"name": "<string>"
}
},
"permissions": {
"is_admin": true,
"can_manage_documents": true,
"can_manage_api_keys": true,
"has_monitoring_permission": true
},
"settings": {
"language": "<string>",
"agent_instructions": "<string>",
"skip_help_step": true
},
"compliance": {
"terms_accepted": true
},
"group_memberships": [
{
"group": {
"id": 123,
"name": "<string>",
"category": "company"
},
"role": "owner"
}
]
}{
"id": null,
"code": 400,
"error": "bad_request",
"detail": "The request body could not be parsed as valid JSON.",
"doc_url": "https://developers.lighton.ai/errors#bad_request"
}{
"id": null,
"code": 401,
"error": "unauthorized",
"detail": "Authentication credentials were not provided or are invalid.",
"doc_url": "https://developers.lighton.ai/errors#unauthorized"
}{
"id": null,
"code": 403,
"error": "insufficient_permissions",
"detail": "You do not have permission to perform this action.",
"doc_url": "https://developers.lighton.ai/errors#insufficient_permissions"
}{
"id": null,
"code": 422,
"error": "validation_error",
"detail": "One or more fields failed validation.",
"doc_url": "https://developers.lighton.ai/errors#validation_error",
"fields": {
"<field_name>": [
{
"error": "required",
"detail": "This field is required."
}
]
}
}{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Update current user profile
Updates settings for the authenticated user.
Updatable fields:
language: User’s preferred languageskip_help_step: Whether to skip help steps in the UIagent_instructions: Custom instructions for AI agentsterms_accepted: Accept the latest terms and conditions (can only be set to true)persona: What the user is trying to achieve (captured at onboarding)channel: How the user will mostly interact (captured at onboarding)
Note: Setting terms_accepted to false will result in a 400 error.
curl --request PATCH \
--url https://paradigm.lighton.ai/api/v3/users/me \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_instructions": "<string>",
"skip_help_step": true,
"terms_accepted": true
}
'import requests
url = "https://paradigm.lighton.ai/api/v3/users/me"
payload = {
"agent_instructions": "<string>",
"skip_help_step": True,
"terms_accepted": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({agent_instructions: '<string>', skip_help_step: true, terms_accepted: true})
};
fetch('https://paradigm.lighton.ai/api/v3/users/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"has_usable_password": true,
"email_verified": true,
"roles": [
"<string>"
],
"persona": "integrate",
"channel": "api",
"profile": {
"id": 123,
"username": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"display": "<string>"
},
"company": {
"id": 123,
"name": "<string>",
"tier": "free",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"login_method": "password",
"ldap_logout_url": "<string>",
"group": {
"id": 123,
"name": "<string>"
}
},
"permissions": {
"is_admin": true,
"can_manage_documents": true,
"can_manage_api_keys": true,
"has_monitoring_permission": true
},
"settings": {
"language": "<string>",
"agent_instructions": "<string>",
"skip_help_step": true
},
"compliance": {
"terms_accepted": true
},
"group_memberships": [
{
"group": {
"id": 123,
"name": "<string>",
"category": "company"
},
"role": "owner"
}
]
}{
"id": null,
"code": 400,
"error": "bad_request",
"detail": "The request body could not be parsed as valid JSON.",
"doc_url": "https://developers.lighton.ai/errors#bad_request"
}{
"id": null,
"code": 401,
"error": "unauthorized",
"detail": "Authentication credentials were not provided or are invalid.",
"doc_url": "https://developers.lighton.ai/errors#unauthorized"
}{
"id": null,
"code": 403,
"error": "insufficient_permissions",
"detail": "You do not have permission to perform this action.",
"doc_url": "https://developers.lighton.ai/errors#insufficient_permissions"
}{
"id": null,
"code": 422,
"error": "validation_error",
"detail": "One or more fields failed validation.",
"doc_url": "https://developers.lighton.ai/errors#validation_error",
"fields": {
"<field_name>": [
{
"error": "required",
"detail": "This field is required."
}
]
}
}{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
ar- Arabicen- Englishfr- Frenchde- German
ar, en, fr, de integrate- Integrate search into my productno_code- Search my docs, no codeevaluate- Evaluate / compare RAG solutionsexploring- Just exploring
integrate, no_code, evaluate, exploring api- Integrating within my softwaremcp- Plug it quickly into my agent
api, mcp Response
The updated current user profile.
Everything about the currently authenticated user.
Whether the user has a password set (false for SSO/LDAP-only).
Whether the user's primary email has been verified.
The user's role slugs, e.g. company_admin.
What the user is trying to achieve, captured at onboarding.
integrate- integrateno_code- no_codeevaluate- evaluateexploring- exploring
integrate, no_code, evaluate, exploring How the user will mostly interact, captured at onboarding.
api- apimcp- mcp
api, mcp The user's identity.
Show child attributes
Show child attributes
The user's company. Null if the user has no company.
Show child attributes
Show child attributes
What the user is allowed to do.
Show child attributes
Show child attributes
The user's preferences.
Show child attributes
Show child attributes
The user's legal acceptance status.
Show child attributes
Show child attributes
The groups the user belongs to, with their role in each.
Show child attributes
Show child attributes