Skip to main content

Create Profile

POST /v1/profile
Register a profile for AI personalization.

Request

Free-form JSON — you can include any fields that fit your tenant’s service.
{ // Example data — you can freely define any fields to feed into the model.
  "name": "John Doe",
  "age": 40,
  "gender": "M",
  "locale": "en",
  "preference": "curry",
  "store_id": "S001"
}

Response

{
  "success": true,
  "data": {
    "profile_id": "d28fd898-bfa0-4444-be38-c0655f5f8307"
  }
}

Get Profile

GET /v1/profile/{profile_id}
Retrieve information for a specific profile.

Response

{
  "success": true,
  "data": {
    "profile_id": "d28fd898-bfa0-4444-be38-c0655f5f8307",
    "data": {
      "name": "John Doe",
      "age": 40,
      "gender": "M",
      "locale": "en",
      "preference": "curry",
      "store_id": "S001"
    }
  }
}

Update Profile

PUT /v1/profile/{profile_id}
Update profile information. Existing fields are overwritten with the latest values, and new fields are added to the existing data.

Request

{
  "locale": "ja",
  "preference": "wine"
}

Response

The full merged data is returned in the same format as the get response.

Delete Profile

DELETE /v1/profile/{profile_id}
A deleted profile cannot be restored.

Response

{
  "success": true,
  "data": {
    "profile_id": "d28fd898-bfa0-4444-be38-c0655f5f8307",
    "data": {
      "name": "John Doe",
      "age": 40,
      "gender": "M",
      "locale": "ja",
      "preference": "wine",
      "store_id": "S001"
    }
  }
}