User

User API cho phép bạn:

• Lấy thông tin tài khoản đang sở hữu API Key.
• Lấy danh sách ghi chú của tài khoản đó.
• Lọc, sắp xếp và phân trang danh sách ghi chú.

Base URL:

https://api.notexapp.com

Gửi API Key trong header X-API-Key:

-H "X-API-Key: ntx_live_..."

Mọi dữ liệu trả về đều thuộc tài khoản đã tạo API Key đang được sử dụng.

Response format

Các endpoint trong tài liệu này sử dụng response wrapper chung:

interface ApiResponse<T> {
  statusCode: number;
  message?: string;
  data: T;
}

Get profile

GET /v1/user/profile

Lấy thông tin tài khoản đang được API Key đại diện.

Endpoint này hữu ích khi bạn cần:

• Kiểm tra API Key thuộc tài khoản nào.
• Hiển thị thông tin người dùng trong hệ thống tích hợp.
• Đọc các thiết lập ngôn ngữ của tài khoản.

Request

Endpoint không yêu cầu query parameter hoặc request body.

curl https://api.notexapp.com/v1/user/profile \
  -H "X-API-Key: ntx_live_..."

Example response

{
  "statusCode": 200,
  "data": {
    "user_id": "665f...",
    "email": "user@example.com",
    "name": "Jane Doe",
    "image": "https://cdn.notexapp.com/avatars/...",
    "role": "normal_user",
    "preferences": {
      "display_language": "en",
      "transcription_language": "en",
      "ai_notes_language": "en"
    },
    "createdAt": "2026-01-01T00:00:00Z"
  }
}

Response fields

Preferences

List my notes

GET /v2/user/notes

Lấy danh sách ghi chú thuộc tài khoản đang sử dụng API Key.

Endpoint hỗ trợ:

• Lọc theo loại ghi chú.
• Lọc theo tab.
• Sắp xếp danh sách.
• Phân trang theo số trang hoặc cursor.

Request

Ví dụ lấy 20 ghi chú mới nhất:

curl "https://api.notexapp.com/v2/user/notes?limit=20&sort_field=createdAt&sort_order=-1" \
  -H "X-API-Key: ntx_live_..."

Query parameters

Common examples

Lọc theo loại ghi chú

curl "https://api.notexapp.com/v2/user/notes?type=pdf&limit=20" \
  -H "X-API-Key: ntx_live_..."

Sắp xếp mới nhất trước

curl "https://api.notexapp.com/v2/user/notes?sort_field=createdAt&sort_order=-1" \
  -H "X-API-Key: ntx_live_..."

Lấy trang tiếp theo bằng cursor

curl "https://api.notexapp.com/v2/user/notes?limit=20&cursor=<next_cursor>" \
  -H "X-API-Key: ntx_live_..."

Hãy sử dụng nguyên giá trị next_cursor được trả về từ request trước. Không tự chỉnh sửa cursor.

Note fields

Mỗi ghi chú trong danh sách có thể chứa các field sau:

Pagination fields

Tùy theo cơ chế phân trang, response có thể bao gồm:

Pagination

API hỗ trợ hai kiểu phân trang:

Không nên truyền đồng thời page và cursor trong cùng một request.

Notes

• Chỉ gọi API từ backend hoặc server được kiểm soát.
• Không đưa API Key vào frontend hoặc mã nguồn công khai.
• Dùng sort_order=-1 để lấy ghi chú mới nhất trước.
• Các field tùy chọn có thể không xuất hiện trong mọi ghi chú.
• Giá trị hợp lệ của type và tab phụ thuộc vào các loại nội dung Notex đang hỗ trợ.