Bearer token (http)
Send a bearer token
(“JWT” Formatted)
in the Authorization http header
to authenticate with the API.
Cosmily V1 API Docs!
1.0.0
Skin-tech community
This is the documentation for version 1.0.0
of the API. Last update on Dec 14, 2022.
This API is provided under license Apache, 2.0.
Base URL
https://api.cosmily.com/api/v1Authentication
Analyze
Operations
- POST
- /analyze/ingredient_list
- GET
- /analyze/ingredient_groups
- GET
- /analyze/ingredient_group
- PATCH
- /analyze/claim/{token}
- GET
- /analyze/shared/{token}
- GET
- /analyze/{token}/ingredient_feelings
- GET
- /analyze/{token}/categorize
- GET
- /analyze/{token}/missing_ingredients
- GET
- /analyze/{token}/personalize
- GET
- /analyze/{token}/skin_calc
- GET
- /analyze/{token}/rules
- GET
- /analyze/{token}/similar_products
- POST
- /analyze/effects
- POST
- /analyze/extract_label
POST /analyze/ingredient_list
POST
/analyze/ingredient_list
Returns the analysis of an ingredient list
Body Required
-
ingredients string Required
-
start_from_uuid string(uuid)
-
ingredient_group string
Responses
-
• 201 object
successful operation
-
analysis object
-
total_ingredients integer
-
ingredients_table array[object]
-
alias string
-
boolean_properties object
-
acne_fighting boolean
-
aha boolean
-
alcohol boolean
-
allergen boolean
-
anti_aging boolean
-
antioxidant boolean
-
antiseptic boolean
-
bad_for_dry_skin boolean
-
bad_for_oily_skin boolean
-
bad_for_sensitive_skin boolean
-
bha boolean
-
ceramide boolean
-
fragrance boolean
-
fungal_acne_feeding boolean
-
gluten boolean
-
good_for_dry_skin boolean
-
good_for_oily_skin boolean
-
good_for_sensitive_skin boolean
-
healing boolean
-
hyaluronic_acid boolean
-
moisturising boolean
-
niacinamide boolean
-
paraben boolean
-
peg boolean
-
pha boolean
-
retinoid boolean
-
silicone boolean
-
softening boolean
-
soothing boolean
-
sulfate boolean
-
uv_protecting boolean
-
vitamin boolean
-
whitening boolean
-
-
categories string
-
cir_rating string
-
ewg object
-
id integer
-
index integer
-
integer_properties object
-
comedogenic_rating integer
-
natural integer
-
-
introtext string
-
title string
-
-
harmful object
-
alcohol object
-
allergen object
-
comedogenic_rating object
-
fragrance object
-
fungal_acne_feeding object
-
gluten object
-
paraben object
-
peg object
-
silicone object
-
sulfate object
-
-
positive object
-
acne_fighting object
-
anti_aging object
-
antioxidant object
-
antiseptic object
-
healing object
-
moisturising object
-
softening object
-
soothing object
-
uv_protecting object
-
whitening object
-
-
notable object
-
aha object
-
antioxidant object
-
bha object
-
ceramide object
-
hyaluronic_acid object
-
niacinamide object
-
pha object
-
retinoid object
-
vitamin object
-
-
ewg object
-
natural object
-
text string
-
description string
-
share_token string(uuid)
-
owner_user object
-
ingredient_group string
-
permissions object
-
can_create_product boolean
-
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 422
Unprocessable Entity
-
• 500
Server Error
POST /analyze/ingredient_list
curl \
-X POST https://api.cosmily.com/api/v1/analyze/ingredient_list \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"ingredients":"string","start_from_uuid":"string","ingredient_group":"string"}'
Request example
{
"ingredients": "string",
"start_from_uuid": "string",
"ingredient_group": "string"
}
Response example (201)
{
"analysis": {
"total_ingredients": 42,
"ingredients_table": [
{
"alias": "string",
"boolean_properties": {
"acne_fighting": true,
"aha": true,
"alcohol": true,
"allergen": true,
"anti_aging": true,
"antioxidant": true,
"antiseptic": true,
"bad_for_dry_skin": true,
"bad_for_oily_skin": true,
"bad_for_sensitive_skin": true,
"bha": true,
"ceramide": true,
"fragrance": true,
"fungal_acne_feeding": true,
"gluten": true,
"good_for_dry_skin": true,
"good_for_oily_skin": true,
"good_for_sensitive_skin": true,
"healing": true,
"hyaluronic_acid": true,
"moisturising": true,
"niacinamide": true,
"paraben": true,
"peg": true,
"pha": true,
"retinoid": true,
"silicone": true,
"softening": true,
"soothing": true,
"sulfate": true,
"uv_protecting": true,
"vitamin": true,
"whitening": true
},
"categories": "string",
"cir_rating": "string",
"ewg": {
"background": "string",
"data": "string",
"decision": "string",
"max": 42,
"min": 42,
"url": "string"
},
"id": 42,
"index": 42,
"integer_properties": {
"comedogenic_rating": 42,
"natural": 42
},
"introtext": "string",
"title": "string"
}
],
"harmful": {
"alcohol": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"allergen": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"comedogenic_rating": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"fragrance": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"fungal_acne_feeding": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"gluten": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"paraben": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"peg": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"silicone": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"sulfate": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
}
},
"positive": {
"acne_fighting": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"anti_aging": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"antioxidant": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"antiseptic": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"healing": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"moisturising": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"softening": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"soothing": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"uv_protecting": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"whitening": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
}
},
"notable": {
"aha": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"antioxidant": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"bha": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"ceramide": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"hyaluronic_acid": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"niacinamide": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"pha": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"retinoid": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"vitamin": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
}
},
"ewg": {
"high": {
"count": 42,
"percent": 42.0
},
"low": {
"count": 42,
"percent": 42.0
},
"moderate": {
"count": 42,
"percent": 42.0
},
"unknown": {
"count": 42,
"percent": 42.0
}
},
"natural": {
"organic": {
"count": 42,
"percent": 42.0
},
"synthetic": {
"count": 42,
"percent": 42.0
},
"unknown": {
"count": 42,
"percent": 42.0
}
},
"text": "string",
"description": "string",
"share_token": "string",
"owner_user": {
"id": 42,
"username": "string"
},
"ingredient_group": "string",
"permissions": {
"can_create_product": true
}
}
}
GET /analyze/ingredient_groups
curl \
-X GET https://api.cosmily.com/api/v1/analyze/ingredient_groups \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"ingredient_groups": [
"string"
]
}Query parameters
-
ingredient_group string Required
filter based on ingredient group
GET /analyze/ingredient_group
curl \
-X GET https://api.cosmily.com/api/v1/analyze/ingredient_group?ingredient_group=string \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"log_uuid": "string"
}PATCH /analyze/claim/:token
PATCH
/analyze/claim/{token}
Marks an unowned ingredient analysis as owned by the logged in user
Path parameters
-
token string(uuid) Required
token reference to desired resource
Responses
-
• 200 object
successful operation
-
result string
Values are
claimedornop. -
share_token string(uuid)
-
owner_user object
-
ingredient_group string
-
permissions object
-
can_create_product boolean
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Ingredient Analysis Not Found
-
• 409
Conflict occurred
-
• 422
Unprocessable Entity
-
• 500
Server Error
PATCH /analyze/claim/{token}
curl \
-X PATCH https://api.cosmily.com/api/v1/analyze/claim/{token} \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"result": "claimed",
"share_token": "string",
"owner_user": {
"id": 42,
"username": "string"
},
"ingredient_group": "string",
"permissions": {
"can_create_product": true
}
}Path parameters
-
token string(uuid) Required
token reference to desired resource
Responses
-
• 200 object
successful operation
-
analysis object
-
total_ingredients integer
-
ingredients_table array[object]
-
alias string
-
boolean_properties object
-
acne_fighting boolean
-
aha boolean
-
alcohol boolean
-
allergen boolean
-
anti_aging boolean
-
antioxidant boolean
-
antiseptic boolean
-
bad_for_dry_skin boolean
-
bad_for_oily_skin boolean
-
bad_for_sensitive_skin boolean
-
bha boolean
-
ceramide boolean
-
fragrance boolean
-
fungal_acne_feeding boolean
-
gluten boolean
-
good_for_dry_skin boolean
-
good_for_oily_skin boolean
-
good_for_sensitive_skin boolean
-
healing boolean
-
hyaluronic_acid boolean
-
moisturising boolean
-
niacinamide boolean
-
paraben boolean
-
peg boolean
-
pha boolean
-
retinoid boolean
-
silicone boolean
-
softening boolean
-
soothing boolean
-
sulfate boolean
-
uv_protecting boolean
-
vitamin boolean
-
whitening boolean
-
-
categories string
-
cir_rating string
-
ewg object
-
id integer
-
index integer
-
integer_properties object
-
comedogenic_rating integer
-
natural integer
-
-
introtext string
-
title string
-
-
harmful object
-
alcohol object
-
allergen object
-
comedogenic_rating object
-
fragrance object
-
fungal_acne_feeding object
-
gluten object
-
paraben object
-
peg object
-
silicone object
-
sulfate object
-
-
positive object
-
acne_fighting object
-
anti_aging object
-
antioxidant object
-
antiseptic object
-
healing object
-
moisturising object
-
softening object
-
soothing object
-
uv_protecting object
-
whitening object
-
-
notable object
-
aha object
-
antioxidant object
-
bha object
-
ceramide object
-
hyaluronic_acid object
-
niacinamide object
-
pha object
-
retinoid object
-
vitamin object
-
-
ewg object
-
natural object
-
text string
-
description string
-
share_token string(uuid)
-
owner_user object
-
ingredient_group string
-
permissions object
-
can_create_product boolean
-
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Shared Ingredient List Analysis Not Found
-
• 500
Server Error
GET /analyze/shared/{token}
curl \
-X GET https://api.cosmily.com/api/v1/analyze/shared/{token} \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"analysis": {
"total_ingredients": 42,
"ingredients_table": [
{
"alias": "string",
"boolean_properties": {
"acne_fighting": true,
"aha": true,
"alcohol": true,
"allergen": true,
"anti_aging": true,
"antioxidant": true,
"antiseptic": true,
"bad_for_dry_skin": true,
"bad_for_oily_skin": true,
"bad_for_sensitive_skin": true,
"bha": true,
"ceramide": true,
"fragrance": true,
"fungal_acne_feeding": true,
"gluten": true,
"good_for_dry_skin": true,
"good_for_oily_skin": true,
"good_for_sensitive_skin": true,
"healing": true,
"hyaluronic_acid": true,
"moisturising": true,
"niacinamide": true,
"paraben": true,
"peg": true,
"pha": true,
"retinoid": true,
"silicone": true,
"softening": true,
"soothing": true,
"sulfate": true,
"uv_protecting": true,
"vitamin": true,
"whitening": true
},
"categories": "string",
"cir_rating": "string",
"ewg": {
"background": "string",
"data": "string",
"decision": "string",
"max": 42,
"min": 42,
"url": "string"
},
"id": 42,
"index": 42,
"integer_properties": {
"comedogenic_rating": 42,
"natural": 42
},
"introtext": "string",
"title": "string"
}
],
"harmful": {
"alcohol": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"allergen": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"comedogenic_rating": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"fragrance": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"fungal_acne_feeding": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"gluten": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"paraben": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"peg": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"silicone": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
},
"sulfate": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"slug": "string",
"title": "string"
}
},
"positive": {
"acne_fighting": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"anti_aging": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"antioxidant": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"antiseptic": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"healing": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"moisturising": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"softening": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"soothing": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"uv_protecting": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"whitening": {
"count": 42,
"description": "string",
"image_url": "string",
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
}
},
"notable": {
"aha": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"antioxidant": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"bha": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"ceramide": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"hyaluronic_acid": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"niacinamide": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"pha": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"retinoid": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
},
"vitamin": {
"count": 42,
"list": [
{
"index": 42,
"title": "string",
"alias": "string"
}
],
"title": "string"
}
},
"ewg": {
"high": {
"count": 42,
"percent": 42.0
},
"low": {
"count": 42,
"percent": 42.0
},
"moderate": {
"count": 42,
"percent": 42.0
},
"unknown": {
"count": 42,
"percent": 42.0
}
},
"natural": {
"organic": {
"count": 42,
"percent": 42.0
},
"synthetic": {
"count": 42,
"percent": 42.0
},
"unknown": {
"count": 42,
"percent": 42.0
}
},
"text": "string",
"description": "string",
"share_token": "string",
"owner_user": {
"id": 42,
"username": "string"
},
"ingredient_group": "string",
"permissions": {
"can_create_product": true
}
}
}GET /analyze/:token/ingredient_feelings
GET
/analyze/{token}/ingredient_feelings
Returns feelings for each ingredient with feelings
Path parameters
-
token string(uuid) Required
token reference to desired resource
Responses
-
• 200 object
successful operation
-
data array[object]
-
id integer
-
active boolean
-
feeling_type string
Values are
positiveornegative. -
created_at string(DateTime)
-
updated_at string(DateTime)
-
ingredient_id integer
-
author_user_id integer
-
author_user object
-
id integer
-
username string
-
user_type string
-
last_active string
-
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Ingredient List Analysis Not Found
-
• 500
Server Error
GET /analyze/{token}/ingredient_feelings
curl \
-X GET https://api.cosmily.com/api/v1/analyze/{token}/ingredient_feelings \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"data": [
{
"id": 42,
"active": true,
"feeling_type": "positive",
"created_at": "string",
"updated_at": "string",
"ingredient_id": 42,
"author_user_id": 42,
"author_user": {
"id": 42,
"username": "string",
"user_type": "string",
"last_active": "string"
}
}
]
}GET /analyze/:token/categorize
GET
/analyze/{token}/categorize
Infers the product category of an ingredient analysis
Path parameters
-
token string(uuid) Required
token reference to desired resource
Responses
-
• 200 object
successful operation
-
category string
Values are
cleanser,toner,serum,moisturizer, orspf.
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Ingredient List Analysis Not Found
-
• 422 object
Failed to infer product category
-
error string
Value is
unknown.
-
-
• 500
Server Error
GET /analyze/{token}/categorize
curl \
-X GET https://api.cosmily.com/api/v1/analyze/{token}/categorize \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"category": "cleanser"
}
Response example (422)
{
"error": "unknown"
}GET /analyze/:token/missing_ingredients
GET
/analyze/{token}/missing_ingredients
Returns missing ingredients for analyze token
Path parameters
-
token string(uuid) Required
token reference to desired resource
GET /analyze/{token}/missing_ingredients
curl \
-X GET https://api.cosmily.com/api/v1/analyze/{token}/missing_ingredients \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
[
"string"
]GET /analyze/:token/personalize
GET
/analyze/{token}/personalize
Runs a personalized ruleset on the ingredient analysis
Path parameters
-
token string(uuid) Required
token reference to desired resource
Body Required
-
category string Required
Values are
cleanser,toner,serum,moisturizer, orspf. -
timeslot string
Values are
AM,PM, orBOTH. Default value isBOTH. -
am_routine_id integer
-
pm_routine_id integer
GET /analyze/{token}/personalize
curl \
-X GET https://api.cosmily.com/api/v1/analyze/{token}/personalize \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"category":"cleanser","timeslot":"BOTH","am_routine_id":42,"pm_routine_id":42}'
Request example
{
"category": "cleanser",
"timeslot": "BOTH",
"am_routine_id": 42,
"pm_routine_id": 42
}
Response example (200)
{
"failing_rules": {
"preference": [
{
"rule": [
"string"
],
"message": "string"
}
],
"safety": [
{
"rule": [
"string"
],
"message": "string"
}
],
"product": [
{
"rule": [
"string"
],
"message": "string"
}
],
"routine": [
{
"rule": [
"string"
],
"message": "string"
}
]
}
}Path parameters
-
token string(uuid) Required
token reference to desired resource
Responses
-
• 200 object
successful operation
-
data object
-
ingredients object
-
bad_aliases array[object]
-
alias string
-
supergroup string
-
reason string
-
-
good_aliases array[object]
-
alias string
-
supergroup string
-
reason string
-
-
-
rules array[object]
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Ingredient List Analysis Not Found
-
• 422
Unprocessable Entity
-
• 500
Server Error
GET /analyze/{token}/skin_calc
curl \
-X GET https://api.cosmily.com/api/v1/analyze/{token}/skin_calc \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"data": {
"ingredients": {
"bad_aliases": [
{
"alias": "string",
"supergroup": "string",
"reason": "string"
}
],
"good_aliases": [
{
"alias": "string",
"supergroup": "string",
"reason": "string"
}
]
},
"rules": [
{
"type": "string",
"category": "string",
"message": "string"
}
]
}
}Path parameters
-
token string(uuid) Required
token reference to desired resource
Query parameters
-
category string Required
rules based on category
Values are
cleanser,toner,serum,moisturizer,spf, orother. -
time_of_day string
rules based on time of day
Values are
AM,PM, orBOTH. Default value isBOTH. -
is_living_hot_summer boolean
rules based on is_living_hot_summer
-
is_living_cold_winter boolean
rules based on is_living_cold_winter
-
is_living_dry_climate boolean
rules based on is_living_dry_climate
-
is_living_urban_area boolean
rules based on is_living_urban_area
-
is_constrained_budget boolean
rules based on is_constrained_budget
-
is_constrained_time boolean
rules based on is_constrained_time
-
is_high_sun_exposure boolean
rules based on is_high_sun_exposure
-
is_concerned_parabens boolean
rules based on is_concerned_parabens
Default value is
true. -
is_concerned_sulfates boolean
rules based on is_concerned_sulfates
Default value is
true. -
is_concerned_silicones boolean
rules based on is_concerned_silicones
Default value is
true. -
is_concerned_gluten boolean
rules based on is_concerned_gluten
-
is_condition_acne boolean
rules based on is_condition_acne
-
is_condition_eczema boolean
rules based on is_condition_eczema
-
is_condition_rosacea boolean
rules based on is_condition_rosacea
-
is_condition_dehydration boolean
rules based on is_condition_dehydration
-
rating_persona_oily integer Required
rules based on rating_persona_oily
Values are
0,1,2,3,4, or5. -
rating_persona_sensitive integer Required
rules based on rating_persona_sensitive
Values are
0,1,2,3,4, or5. -
rating_persona_uneven integer Required
rules based on rating_persona_uneven
Values are
0,1,2,3,4, or5. -
rating_persona_wrinkled integer Required
rules based on rating_persona_wrinkled
Values are
0,1,2,3,4, or5.
Responses
-
• 200 object
successful operation
-
data object
-
bad_ingredients object
-
reason string
-
ingredient object
-
explanation string
-
-
is_good_for_you boolean
-
failed_product_rules array[object]
-
explanation string
-
identifier string
-
label string
-
-
suggestion object
-
explanations array[string]
-
products array[object]
-
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Ingredient List Analysis Not Found
-
• 422 object
Failed to infer product category
-
error string
Value is
unknown.
-
-
• 500
Server Error
GET /analyze/{token}/rules
curl \
-X GET https://api.cosmily.com/api/v1/analyze/{token}/rules?category=cleanser&rating_persona_oily=0&rating_persona_sensitive=0&rating_persona_uneven=0&rating_persona_wrinkled=0 \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"data": {
"bad_ingredients": {
"reason": "string",
"ingredient": {
"id": 42,
"title": "string",
"alias": "string"
},
"explanation": "string"
},
"is_good_for_you": true,
"failed_product_rules": [
{
"explanation": "string",
"identifier": "string",
"label": "string"
}
],
"suggestion": {
"explanations": [
"string"
],
"products": [
{
"id": 42,
"title": "string",
"alias": "string"
}
]
}
}
}
Response example (422)
{
"error": "unknown"
}GET /analyze/:token/similar_products
GET
/analyze/{token}/similar_products
Returns products similar to the ingredient list analysis
Path parameters
-
token string(uuid) Required
token reference to desired resource
Responses
-
• 200 object
successful operation
-
similar array[object]
-
product_id integer
-
category_id integer
-
score integer
-
percent_match integer
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Ingredient List Analysis Not Found
-
• 422
Unprocessable Entity
-
• 500
Server Error
GET /analyze/{token}/similar_products
curl \
-X GET https://api.cosmily.com/api/v1/analyze/{token}/similar_products \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"similar": [
{
"product_id": 42,
"category_id": 42,
"score": 42,
"percent_match": 42
}
]
}POST /analyze/effects
POST
/analyze/effects
Returns the positive, harmful, and notable effects for the submitted list of ingredients
Body Required
-
ingredient_ids array[integer] Required
Responses
-
• 200 object
successful operation
-
effects object
-
positive array[object]
-
effect string
-
ingredient_ids array[integer]
-
-
harmful array[object]
-
effect string
-
ingredient_ids array[integer]
-
-
notable array[object]
-
effect string
-
ingredient_ids array[integer]
-
-
-
supported object
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Requested resource not found
-
• 422
Unprocessable Entity
-
• 500
Server Error
POST /analyze/effects
curl \
-X POST https://api.cosmily.com/api/v1/analyze/effects \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"ingredient_ids":[42]}'
Request example
{
"ingredient_ids": [
42
]
}
Response example (200)
{
"effects": {
"positive": [
{
"effect": "string",
"ingredient_ids": [
42
]
}
],
"harmful": [
{
"effect": "string",
"ingredient_ids": [
42
]
}
],
"notable": [
{
"effect": "string",
"ingredient_ids": [
42
]
}
]
},
"supported": {
"positive": [],
"harmful": [],
"notable": []
}
}POST /analyze/extract_label
POST
/analyze/extract_label
Extracts a label (list of ingredients) from an arbitrary text block
Body Required
-
input_text string Required
POST /analyze/extract_label
curl \
-X POST https://api.cosmily.com/api/v1/analyze/extract_label \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"input_text":"string"}'
Request example
{
"input_text": "string"
}
Response example (200)
{
"label": [
"string"
]
}Articles
Operations
Responses
-
• 200 object
successful operation
-
data array[object]
-
id integer
-
alias string
-
title string
-
description string
-
content string
-
author_user_id integer
-
created_at string(DateTime)
-
updated_at string(DateTime)
-
-
links object
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 500
Server Error
GET /articles
curl \
-X GET https://api.cosmily.com/api/v1/articles \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"data": [
{
"id": 1,
"alias": "cosrx-aha-bha-clarifying-treatment-toner-review-1",
"title": "COSRX AHA/BHA Clarifying Treatment Toner Review",
"description": "Hello! Today I'm going to review a COSRX AHA/BHA Clarifying Treatment Toner manufactured by famous Korean brand COSRX. I've been regularly using this product for more than a month and I have a lot to share with you. Make sure you have read this",
"content": "<p>Hello! Today I'm going to review a <strong>COSRX AHA/BHA Clarifying Treatment Toner</strong> manufactured by famous Korean brand <strong><a href=\"/brands/cosrx\">COSRX</a></strong>. I've been regularly using this product for more than a month and I have a lot to share with you.Make sure you have read this article till the end because the most important information is there.</p> <p>The toner is made for <strong>removing dead skin cells</strong> and for <strong>increasing skin flexibility</strong>. The product contains mineral water, natural AHA (Pyrus Malus Apple Fruit Water 10%), natural BHA and some additional stuff like allantoin to moisturize the skin and make it smoother. The manufacturer reports that it allows you to prevent whiteheads and blackheads, so if you have such problems this toner is worth trying.</p> <p><b>Here is a full list of active Ingredients:</b> Mineral Water, Salix Alba (Willow) Bark Water, Pyrus Malus (Apple) Fruit Water, Butylene Glycol, 1,2-Hexanediol, Sodium Lactate, Glycolic Acid, Water, Betaine Salicylate, Allantoin, Panthenol, Ethyl Hexanediol. </p><p>As you see the list is very short: only 12 ingredients and most of them are natural. The main goal of a company is to produce high-quality products using zero harmful ingredients and a large number of good components.</p> <p>The price varies from 10 USD to 15 USD depending on the seller. Some sellers offer to buy several toners at once but the price doesn’t seem to be lower. Visit Amazon to see actual prices. As you see the price is really low and it’s a perfect opportunity to try AHA/BHA product at a very cheap price.</p><p><img src=\"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAQ8B0mBNpGO7V7V6D9DU1adPAAABHSA0gNIDSA0gNIEgI6QGkCQACOkBpAAD//Z\"><br></p> <p></p> <p><strong>The package doesn’t look expensive. </strong>It’s an ordinary box without any special drawing. The bottle and the sprayer look standard. COSRX tradition is to make products with a minimalistic design. That’s cheaper and allows the company to lower the price. Fortunately, this doesn’t affect the quality. Personally, I don’t care about the package. But I really care about what’s inside.</p> <p></p> <p>Though the bottle and sprayer look simple, <strong>they work great</strong> and to their job as they should. The nozzle sprays out a fine portion of toner and I like how it works.</p> <p>But a slight problem may occur at the end of its life: there may be some toner left at the bottom and you will have to open the bottle because sprayer will not be able to take everything out. This is a standard problem of many sprayers. </p> <h2>How to use it?</h2> <p>The usage process is simple: apply some toner to your face and massage the skin with a cotton pad. The matter feels very watery. That’s not a big surprise: just return and see what it is made off. The number one ingredient is mineral water…</p> <p>Some people recommend applying the toner to the cotton pad and then massage the skin with it. But I don’t recommend doing this. If you use it with a cotton pad you will spend much more productive than if you just spray it on the face and use the pad after this.</p> <p>But you need to use a cotton pad to remove dead skin anyway. If you don’t remove dead skin, you may see less results from using it.</p> <p>The pH level is low: only 3.9. The normal pH of the human’s skin is 5.5, but despite this, the product feels very good.</p> <p><strong>You can use it twice a day</strong>, in the morning after you wash your face and in the evening. The product is gentle enough and will not irritate your skin. But be careful if you wish using it twice. Your skin may be sensitive to one or more things in this toner. So it’s better to test it in the beginning. Start using it once a day and if everything is ok and your skin feels good to try using it twice.</p> <h2>My Personal Experience with this Treatment Toner</h2> <p>AHA BHA Clarifying Treatment Toner won't be giving you too much of a visible result if your skin is already used to stronger exfoliants. But you may see a good result if you are a beginner in exfoliation with acids.</p> <p>If I want to use BHA at night or in the morning I use this one because I know for a fact that this exfoliator is mild. I also like to use it on my body because it's very refreshing after a workout.</p> <p><b>As for the effectiveness: I didn’t see too much result from this single product, but it’s a good toner to use in a combination with other skincare stuff.</b> I don’t expect great effectiveness from a single toner. But what it really does is it moisturizes the skin and helps to prepare it for the products I use later. How? Because it <strong>temporarily lowers the pH level of the skin</strong>. Lower skin pH allows the acids/actives of the stuff I use later to stay in unchanged form. And this results in better absorption because unchanged acids can pass through the skin deeper.</p> <p>That’s why I absolutely recommend using this toner at the beginning of your self-care routine. This will prepare your skin for further products and make the entire routine much more effective.</p> <p>Thanks for reading my review! I hope you have found a lot of useful information in it. I have also prepared answers to some very popular questions about this product.</p> <p><strong>Q: Does this toner require using a sunscreen after it?</strong></p> <p>A: Yes, it does. It contains AHA which makes your skin a little bit more sensitive to the sun. The effect is not strong, but if your skin is sun-sensitive it’s recommended using a sunscreen.</p> <p><strong>Q: Does it remove whiteheads and blackheads?</strong></p> <p>A: This product doesn’t remove whiteheads and blackheads on its own. It’s better to use it in a combination with other products. But manufacturers report it can prevent whiteheads and blackheads if you use it regularly.</p>",
"author_user_id": 1,
"created_at": "2021-10-04T13:24:22.000Z",
"updated_at": "2021-11-13T20:23:18.000Z"
}
],
"links": {
"first": "/api/v1/articles?page=1",
"last": "/api/v1/articles?page=1"
}
}Path parameters
-
id_or_alias string Required
ID of the resource to return
Responses
-
• 200 object
successful operation
-
data object
-
id integer
-
alias string
-
title string
-
description string
-
content string
-
author object
-
id integer
-
username string
-
last_active string(DateTime)
-
-
created_at string(DateTime)
-
updated_at string(DateTime)
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Article not found
-
• 500
Server Error
GET /articles/{id_or_alias}
curl \
-X GET https://api.cosmily.com/api/v1/articles/{id_or_alias} \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"data": {
"id": 1,
"alias": "cosrx-aha-bha-clarifying-treatment-toner-review-1",
"title": "COSRX AHA/BHA Clarifying Treatment Toner Review",
"description": "Hello! Today I'm going to review a COSRX AHA/BHA Clarifying Treatment Toner manufactured by famous Korean brand COSRX. I've been regularly using this product for more than a month and I have a lot to share with you.Make sure you have read this",
"content": "<p>Hello! Today I'm going to review a <strong>COSRX AHA/BHA Clarifying Treatment Toner</strong> manufactured by famous Korean brand <strong><a href=\"/brands/cosrx\">COSRX</a></strong>. I've been regularly using this product for more than a month and I have a lot to share with you.Make sure you have read this article till the end because the most important information is there.</p> <p>The toner is made for <strong>removing dead skin cells</strong> and for <strong>increasing skin flexibility</strong>. The product contains mineral water, natural AHA (Pyrus Malus Apple Fruit Water 10%), natural BHA and some additional stuff like allantoin to moisturize the skin and make it smoother. The manufacturer reports that it allows you to prevent whiteheads and blackheads, so if you have such problems this toner is worth trying.</p> <p><b>Here is a full list of active Ingredients:</b> Mineral Water, Salix Alba (Willow) Bark Water, Pyrus Malus (Apple) Fruit Water, Butylene Glycol, 1,2-Hexanediol, Sodium Lactate, Glycolic Acid, Water, Betaine Salicylate, Allantoin, Panthenol, Ethyl Hexanediol. </p><p>As you see the list is very short: only 12 ingredients and most of them are natural. The main goal of a company is to produce high-quality products using zero harmful ingredients and a large number of good components.</p> <p>The price varies from 10 USD to 15 USD depending on the seller. Some sellers offer to buy several toners at once but the price doesn’t seem to be lower. Visit Amazon to see actual prices. As you see the price is really low and it’s a perfect opportunity to try AHA/BHA product at a very cheap price.</p><p><img src=\"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAQ8B0mBNpGO7V7V6D9DU1adPAAABHSA0gNIDSA0gNIEgI6QGkCQACOkBpAAD//Z\"><br></p> <p></p> <p><strong>The package doesn’t look expensive. </strong>It’s an ordinary box without any special drawing. The bottle and the sprayer look standard. COSRX tradition is to make products with a minimalistic design. That’s cheaper and allows the company to lower the price. Fortunately, this doesn’t affect the quality. Personally, I don’t care about the package. But I really care about what’s inside.</p> <p></p> <p>Though the bottle and sprayer look simple, <strong>they work great</strong> and to their job as they should. The nozzle sprays out a fine portion of toner and I like how it works.</p> <p>But a slight problem may occur at the end of its life: there may be some toner left at the bottom and you will have to open the bottle because sprayer will not be able to take everything out. This is a standard problem of many sprayers. </p> <h2>How to use it?</h2> <p>The usage process is simple: apply some toner to your face and massage the skin with a cotton pad. The matter feels very watery. That’s not a big surprise: just return and see what it is made off. The number one ingredient is mineral water…</p> <p>Some people recommend applying the toner to the cotton pad and then massage the skin with it. But I don’t recommend doing this. If you use it with a cotton pad you will spend much more productive than if you just spray it on the face and use the pad after this.</p> <p>But you need to use a cotton pad to remove dead skin anyway. If you don’t remove dead skin, you may see less results from using it.</p> <p>The pH level is low: only 3.9. The normal pH of the human’s skin is 5.5, but despite this, the product feels very good.</p> <p><strong>You can use it twice a day</strong>, in the morning after you wash your face and in the evening. The product is gentle enough and will not irritate your skin. But be careful if you wish using it twice. Your skin may be sensitive to one or more things in this toner. So it’s better to test it in the beginning. Start using it once a day and if everything is ok and your skin feels good to try using it twice.</p> <h2>My Personal Experience with this Treatment Toner</h2> <p>AHA BHA Clarifying Treatment Toner won't be giving you too much of a visible result if your skin is already used to stronger exfoliants. But you may see a good result if you are a beginner in exfoliation with acids.</p> <p>If I want to use BHA at night or in the morning I use this one because I know for a fact that this exfoliator is mild. I also like to use it on my body because it's very refreshing after a workout.</p> <p><b>As for the effectiveness: I didn’t see too much result from this single product, but it’s a good toner to use in a combination with other skincare stuff.</b> I don’t expect great effectiveness from a single toner. But what it really does is it moisturizes the skin and helps to prepare it for the products I use later. How? Because it <strong>temporarily lowers the pH level of the skin</strong>. Lower skin pH allows the acids/actives of the stuff I use later to stay in unchanged form. And this results in better absorption because unchanged acids can pass through the skin deeper.</p> <p>That’s why I absolutely recommend using this toner at the beginning of your self-care routine. This will prepare your skin for further products and make the entire routine much more effective.</p> <p>Thanks for reading my review! I hope you have found a lot of useful information in it. I have also prepared answers to some very popular questions about this product.</p> <p><strong>Q: Does this toner require using a sunscreen after it?</strong></p> <p>A: Yes, it does. It contains AHA which makes your skin a little bit more sensitive to the sun. The effect is not strong, but if your skin is sun-sensitive it’s recommended using a sunscreen.</p> <p><strong>Q: Does it remove whiteheads and blackheads?</strong></p> <p>A: This product doesn’t remove whiteheads and blackheads on its own. It’s better to use it in a combination with other products. But manufacturers report it can prevent whiteheads and blackheads if you use it regularly.</p>",
"author": {
"id": 1,
"username": "admin",
"last_active": "2021-10-04T13:24:22.000Z"
},
"created_at": "2021-10-04T13:24:22.000Z",
"updated_at": "2021-11-13T20:23:18.000Z"
}
}Responses
-
• 200 object
successful operation
-
data array[object]
-
id integer
-
alias string
-
title string
-
created_at string(DateTime)
-
updated_at string(DateTime)
-
owner_user_id integer
-
product_count integer
-
owner object
-
id integer
-
username string
-
user_type string
-
last_active string
-
-
-
links object
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 500
Server Error
GET /brands
curl \
-X GET https://api.cosmily.com/api/v1/brands \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"data": [
{
"id": 111,
"alias": "pasjel",
"title": "PasJel",
"product_count": 243,
"created_at": "2021-10-04T13:24:22.000Z",
"updated_at": "2021-11-13T20:23:18.000Z",
"owner": {
"id": 222,
"username": "pasjel_cosmily",
"user_type": "brand",
"last_active": "2022--2-09T21:22:23.000Z"
}
}
],
"links": {
"first": "/api/v1/brands?page=1",
"last": "/api/v1/brands?page=1"
}
}Path parameters
-
id_or_alias string Required
ID of the resource to return
Responses
-
• 200 object
successful operation
-
data object
-
id integer
-
alias string
-
title string
-
created_at string(DateTime)
-
updated_at string(DateTime)
-
owner_user_id integer
-
owner object
-
id integer
-
username string
-
user_type string
-
last_active string
-
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Brand Not Found
-
• 500
Server Error
GET /brands/{id_or_alias}
curl \
-X GET https://api.cosmily.com/api/v1/brands/{id_or_alias} \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"data": {
"id": 111,
"alias": "pasjel",
"title": "PasJel",
"owner": {
"id": 222,
"username": "pasjel_cosmily",
"user_type": "brand",
"last_active": "2021-10-04T13:24:22.000Z"
},
"created_at": "2021-10-04T13:24:22.000Z",
"updated_at": "2021-11-13T20:23:18.000Z"
}
}Path parameters
-
id_or_alias string Required
ID of the resource to return
-
title string
Responses
-
• 200 object
successful operation
-
data object
-
id integer
-
alias string
-
title string
-
created_at string(DateTime)
-
updated_at string(DateTime)
-
owner_user_id integer
-
owner object
-
id integer
-
username string
-
user_type string
-
last_active string
-
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Brand Not Found
-
• 500
Server Error
PATCH /brands/{id_or_alias}
curl \
-X PATCH https://api.cosmily.com/api/v1/brands/{id_or_alias} \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"data": {
"id": 1,
"alias": "pasjel",
"title": "PasJel",
"owner": {
"id": 1,
"username": "admin",
"last_active": "2021-10-04T13:24:22.000Z"
},
"created_at": "2021-10-04T13:24:22.000Z",
"updated_at": "2021-11-13T20:23:18.000Z"
}
}GET /brands/:id_or_alias/products
GET
/brands/{id_or_alias}/products
Returns products for a particular brand via the brandId
Path parameters
-
id_or_alias string Required
ID of the resource to return
Query parameters
-
ft_bool_non_comedogenic boolean
Search by Feature Non-Comedogenic
-
ft_bool_allergen_free boolean
Search by Feature Allergen Free
-
ft_bool_alcohol_free boolean
Search by Feature Alcohol Free
-
ft_bool_gluten_free boolean
Search by Feature Gluten Free
-
ft_bool_silicone_free boolean
Search by Feature Silicone Free
-
ft_bool_sulfate_free boolean
Search by Feature Sulfate Free
-
ft_bool_paraben_free boolean
Search by Feature Paraben Free
-
ft_bool_peg_free boolean
Search by Feature PEG Free
-
ft_bool_fungal_acne_feeding_free boolean
Search by Feature Fungal Acne Feeding Free
-
ft_bool_fragrance_free boolean
Search by Feature Fragrance Free
-
ft_bool_moisturising boolean
Search by Feature Moisturising
-
ft_bool_softening boolean
Search by Feature Softening
-
ft_bool_soothing boolean
Search by Feature Soothing
-
ft_bool_acne_fighting boolean
Search by Feature Acne Fighting
-
ft_bool_anti_aging boolean
Search by Feature Anti-Aging
-
ft_bool_healing boolean
Search by Feature Healing
-
ft_bool_antiseptic boolean
Search by Feature Antiseptic
-
ft_bool_whitening boolean
Search by Feature Brightening
-
ft_bool_uv_protecting boolean
Search by Feature UV Protecting
-
ft_bool_antioxidant boolean
Search by Feature Antioxidant
Responses
-
• 200 object
successful operation
-
data array[object]
-
id integer(int32)
-
title string
-
full_title string
-
alias string
-
raw_label string
-
image string(nullable)
-
asin string
-
published boolean
-
created_at string(DateTime)
-
updated_at string(DateTime)
-
deprecated_at string(nullable)
-
deprecated_reason string(nullable)
-
ingredient_count integer(int32)
-
brand_id integer(int32)
-
category_id integer(int32)
-
owner_user_id integer(int32)
-
ft_bool_non_comedogenic boolean
-
ft_bool_allergen_free boolean
-
ft_bool_alcohol_free boolean
-
ft_bool_gluten_free boolean
-
ft_bool_silicone_free boolean
-
ft_bool_sulfate_free boolean
-
ft_bool_paraben_free boolean
-
ft_bool_peg_free boolean
-
ft_bool_fungal_acne_feeding_free boolean
-
ft_bool_fragrance_free boolean
-
ft_bool_moisturising boolean
-
ft_bool_softening boolean
-
ft_bool_soothing boolean
-
ft_bool_acne_fighting boolean
-
ft_bool_anti_aging boolean
-
ft_bool_healing boolean
-
ft_bool_antiseptic boolean
-
ft_bool_whitening boolean
-
ft_bool_uv_protecting boolean
-
ft_bool_antioxidant boolean
-
ft_bool_ceramide boolean
-
ft_bool_vitamin boolean
-
ft_bool_pha boolean
-
ft_bool_bha boolean
-
ft_bool_aha boolean
-
ft_bool_hyaluronic_acid boolean
-
ft_bool_retinoid boolean
-
ft_bool_niacinamide boolean
-
brand object
-
id integer
-
alias string
-
title string
-
created_at string(DateTime)
-
updated_at string(DateTime)
-
owner_user_id integer
-
-
category object
-
id integer(int32)
-
title string
-
alias string
-
menuindex integer(int32)
-
created_at string(DateTime)
-
updated_at string(DateTime)
-
parent_id integer(int32)
-
-
product_image object
-
id integer
-
product_id integer
-
product_draft_id integer
-
image string
-
url string
-
-
-
links object
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Requested Products For This Brand Not Found
-
• 500
Server Error
GET /brands/{id_or_alias}/products
curl \
-X GET https://api.cosmily.com/api/v1/brands/{id_or_alias}/products \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"data": [
{
"id": 398,
"brand": {
"id": 4,
"alias": "susanne-kaufmann",
"title": "Susanne Kaufmann",
"owner_user_id": 1,
"created_at": "2021-10-04T13:32:53.000Z",
"updated_at": "2021-11-13T20:23:18.000Z"
},
"category": {
"id": 18,
"title": "Sunscreens",
"alias": "sunscreens",
"parent": 1,
"menuindex": 100,
"created_at": "2021-10-04T13:32:53.000Z",
"updated_at": "2021-11-13T20:23:18.000Z"
},
"title": "Sun Cream Cell Protection SPF 25",
"full_title": "Susanne Kaufmann Sun Cream Cell Protection SPF 25",
"alias": "susanne-kaufmann-sun-cream-cell-protection-spf-25",
"raw_label": "Salicylic Acid, Water, Cetyl Alcohol, PPG-15 Stearyl Ether, Polyethylene, Microcrystalline Wax, Steareth-21, Polysorbate 60, Potassium Cetyl Phosphate, Xanthan Gum, Fragrance, Menthyl Lactate, Ferric Ferrocyanide, Jojoba Esters",
"image": "products/398/398",
"asin": null,
"created_at": "2021-10-05T14:21:25.000Z",
"updated_at": "2021-11-13T20:23:18.000Z",
"deprecated_at": null,
"deprecated_reason": null,
"ingredient_count": 16,
"ft_bool_non_comedogenic": false,
"ft_bool_allergen_free": true,
"ft_bool_alcohol_free": true,
"ft_bool_gluten_free": true,
"ft_bool_silicone_free": true,
"ft_bool_sulfate_free": true,
"ft_bool_paraben_free": true,
"ft_bool_peg_free": true,
"ft_bool_fungal_acne_feeding_free": false,
"ft_bool_fragrance_free": false,
"ft_bool_moisturising": true,
"ft_bool_softening": true,
"ft_bool_soothing": true,
"ft_bool_acne_fighting": true,
"ft_bool_anti_aging": false,
"ft_bool_healing": false,
"ft_bool_antiseptic": true,
"ft_bool_whitening": false,
"ft_bool_uv_protecting": false,
"ft_bool_antioxidant": false,
"ft_bool_ceramide": false,
"ft_bool_vitamin": false,
"ft_bool_pha": false,
"ft_bool_bha": false,
"ft_bool_aha": false,
"ft_bool_hyaluronic_acid": false,
"ft_bool_retinoid": false,
"ft_bool_niacinamide": false
}
],
"links": {
"first": "/api/v1/brands/4/products?page=1",
"last": "/api/v1/brands/4/products?page=1"
}
}PATCH /brands/:id_or_alias/transfer_ownership
PATCH
/brands/{id_or_alias}/transfer_ownership
Transfers ownership of a brand
Path parameters
-
id_or_alias string Required
ID of the resource to return
-
owner_user_id integer
Responses
-
• 200 object
successful operation
-
data object
-
id integer
-
alias string
-
title string
-
created_at string(DateTime)
-
updated_at string(DateTime)
-
owner_user_id integer
-
owner object
-
id integer
-
username string
-
user_type string
-
last_active string
-
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 404
Brand Not Found
-
• 500
Server Error
PATCH /brands/{id_or_alias}/transfer_ownership
curl \
-X PATCH https://api.cosmily.com/api/v1/brands/{id_or_alias}/transfer_ownership \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"data": {
"id": 1,
"alias": "pasjel",
"title": "PasJel",
"owner": {
"id": 1,
"username": "admin",
"last_active": "2021-10-04T13:24:22.000Z"
},
"created_at": "2021-10-04T13:24:22.000Z",
"updated_at": "2021-11-13T20:23:18.000Z"
}
}GET /breadcrumbs/product_category/:id_or_alias
GET
/breadcrumbs/product_category/{id_or_alias}
Return all breadcrumbs available for a specific product category
Path parameters
-
id_or_alias string Required
ID of the resource to return
GET /breadcrumbs/product_category/{id_or_alias}
curl \
-X GET https://api.cosmily.com/api/v1/breadcrumbs/product_category/{id_or_alias} \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"data": {
"id": 42,
"title": "string",
"alias": "string",
"menuindex": 42,
"parent_id": 42,
"parent": {
"id": 42,
"title": "string",
"alias": "string",
"menuindex": 42,
"parent_id": 42
},
"children": [
{
"id": 42,
"title": "string",
"alias": "string",
"menuindex": 42,
"parent_id": 42
}
]
}
}GET /breadcrumbs/product/:id_or_alias
GET
/breadcrumbs/product/{id_or_alias}
Return all breadcrumbs for a specific product
Path parameters
-
id_or_alias string Required
ID of the resource to return
GET /breadcrumbs/product/{id_or_alias}
curl \
-X GET https://api.cosmily.com/api/v1/breadcrumbs/product/{id_or_alias} \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"data": [
{
"id": 42,
"title": "string",
"alias": "string",
"menuindex": 42,
"parent_id": 42
}
]
}Path parameters
-
id_or_alias string Required
ID of the resource to return
GET /buy/{id_or_alias}/amzn
curl \
-X GET https://staging.cosmily.com/buy/{id_or_alias}/amzn \
-H "Authorization: Bearer $ACCESS_TOKEN"Path parameters
-
id_or_alias string Required
ID of the resource to return
GET /buy/{id_or_alias}
curl \
-X GET https://staging.cosmily.com/buy/{id_or_alias} \
-H "Authorization: Bearer $ACCESS_TOKEN"Census
Operations
Responses
-
• 200 object
successful operation
-
countries array[object]
-
country_code string
ISO 3166-1 alpha-2 country code identifier
-
country_name string
-
-
-
• 500
Server Error
GET /census/countries
curl \
-X GET https://api.cosmily.com/api/v1/census/countries \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
"countries": [
{
"country_code": "US",
"country_name": "United States of America"
}
]
}Body Required
-
path string Required
a comparison alias is composed of two product aliases separated by '-vs-'
Responses
-
• 200 object
successful operation
-
data object
-
left_product object
-
right_product object
-
comparison_alias string
-
-
links object
-
left_product string(url)
-
right_product string(url)
-
left_analysis string(url)
-
right_analysis string(url)
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 422
Unprocessable Entity
-
• 500
Server Error
POST /compare/expand
curl \
-X POST https://api.cosmily.com/api/v1/compare/expand \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"path":"first_alias-vs-second_alias"}'
Request examples
path can be a comparison alias
{
"path": "first_alias-vs-second_alias"
}{
"path": "https://cosmily.com/some/path/to/compare/first_alias-vs-second_alias"
}
Response example (200)
{
"data": {
"left_product": {
"id": 42,
"alias": "string"
},
"right_product": {
"id": 42,
"alias": "string"
},
"comparison_alias": "string"
},
"links": {
"left_product": "string",
"right_product": "string",
"left_analysis": "string",
"right_analysis": "string"
}
}POST /compare/share
POST
/compare/share
Generate a permanent identifier for sharing a product comparison
Body Required
-
left_product string Required
id or alias of the left product in the comparison
-
right_product string Required
id or alias of the right product in the comparison
Responses
-
• 201 object
successful operation
-
data object
-
left_product object
-
right_product object
-
share_token string(uuid)
-
-
links object
-
left_product string(url)
-
right_product string(url)
-
left_analysis string(url)
-
right_analysis string(url)
-
-
-
• 400
Bad Request
-
• 401
Authorization information is missing or invalid.
-
• 422
Unprocessable Entity
-
• 500
Server Error
POST /compare/share
curl \
-X POST https://api.cosmily.com/api/v1/compare/share \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"left_product":"string","right_product":"string"}'
Request example
{
"left_product": "string",
"right_product": "string"
}
Response example (201)
{
"data": {
"left_product": {
"id": 42,
"alias": "string"
},
"right_product": {
"id": 42,
"alias": "string"
},
"share_token": "string"
},
"links": {
"left_product": "string",
"right_product": "string",
"left_analysis": "string",
"right_analysis": "string"
}
}Path parameters
-
token string(uuid) Required
token reference to desired resource
Responses
-
• 200 object
successful operation
-
data object
-
left_product object
-
right_product object
-
id integer</
-
-
-