Users

Get User Profile

Response

string

required

User ID

string

required

User’s email address

string

required

User’s full name

string | null

required

URL to user’s avatar image (null if not set)

boolean

required

Whether the email has been verified

string

required

Current subscription plan: free, starter, or growth

string

required

ISO 8601 timestamp of account creation

Example Request

curl -X GET "https://api.opensight.ai/api/users/profile" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "id": "user_456",
  "email": "john@example.com",
  "full_name": "John Doe",
  "avatar_url": "https://example.com/avatars/john.jpg",
  "email_verified": true,
  "plan_id": "starter",
  "created_at": "2024-01-01T08:00:00Z"
}

Errors

401 Unauthorized - Invalid or missing authentication
404 Not Found - User profile not found

Update User Profile

Request Body

string

User’s full name (1-255 characters)

string

Valid URL to user’s avatar image

Response

string

required

User ID

string

required

User’s email address (cannot be changed via this endpoint)

string

required

Updated full name

string | null

required

Updated avatar URL

boolean

required

Whether the email has been verified

string

required

Current subscription plan

string

required

ISO 8601 timestamp of account creation

Example Request

curl -X PATCH "https://api.opensight.ai/api/users/profile" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Smith",
    "avatar_url": "https://example.com/avatars/john-new.jpg"
  }'

Example Response

{
  "id": "user_456",
  "email": "john@example.com",
  "full_name": "John Smith",
  "avatar_url": "https://example.com/avatars/john-new.jpg",
  "email_verified": true,
  "plan_id": "starter",
  "created_at": "2024-01-01T08:00:00Z"
}

Errors

401 Unauthorized - Invalid or missing authentication
404 Not Found - User profile not found
400 Bad Request - Invalid input data (e.g., invalid URL format)

Change Password

Request Body

string

required

User’s current password

string

required

New password (min 8 characters, must contain 1 uppercase letter and 1 number)

Response

string

Success confirmation message

Example Request

curl -X PATCH "https://api.opensight.ai/api/users/password" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "current_password": "OldPassword123",
    "new_password": "NewPassword456"
  }'

Example Response

{
  "message": "Password changed successfully"
}

Errors

401 Unauthorized - Invalid or missing authentication
404 Not Found - User not found
400 Bad Request - Current password is incorrect or new password doesn’t meet requirements

Password Requirements

Minimum 8 characters
At least 1 uppercase letter (A-Z)
At least 1 number (0-9)

After changing your password, all existing sessions remain valid. To force logout from all devices, users should revoke their API keys and create new ones.

Account Information

The user profile includes information about the current subscription plan and its limits:

Plan Types

Plan	Brands	Prompts	Competitors	API Keys	Content Scores/Day
Free	1	25	2	2	5
Starter	3	100	5	5	25
Growth	10	250	5	20	100

To upgrade or downgrade plans, users must use the billing portal or checkout flow (not available via API).

Getting Started

Endpoints

Get User Profile

Response

Example Request

Example Response

Errors

Update User Profile

Request Body

Response

Example Request

Example Response

Errors

Change Password

Request Body

Response

Example Request

Example Response

Errors

Password Requirements

Account Information

Plan Types

​Get User Profile

​Response

​Example Request

​Example Response

​Errors

​Update User Profile

​Request Body

​Response

​Example Request

​Example Response

​Errors

​Change Password

​Request Body

​Response

​Example Request

​Example Response

​Errors

​Password Requirements

​Account Information

​Plan Types

Get User Profile

Response

Example Request

Example Response

Errors

Update User Profile

Request Body

Response

Example Request

Example Response

Errors

Change Password

Request Body

Response

Example Request

Example Response

Errors

Password Requirements

Account Information

Plan Types