API docs by Redocly

Falomen AI API (v7.0.0)

Download OpenAPI specification:Download

AI Team: [email protected]

For more details and to download the gRPC proto files, please visit gRPC Proto Files.

CoffeeService

Retrieves a coffee cup reading for the user

Request Body schema: application/json
required
Image_Path
string (User's Uploaded Coffee Cup Image path on Storage Server)
Language
string (User Preferred Language Code (ISO 639-1 standard) (en: for english, fa: for Persian, ar: for Arabic, tr: for Turkish))
User_BirthDate
string (User Birth Date and Time from Profile in YYYY/MM/DD HH:MM format (ISO 8601 standard))
User_Gender
string (User's Gender from profile)
User_ID
string (Unique User ID (ISO/IEC 11578:1996 standard)-(128-bit label, 32 digit))
User_Name
string (User's Full Name from profile)
User_Status
string (User's Martial Status from profile)

Responses

Request samples

Content type
application/json
{
  • "Image_Path": "urn:minio:coffee-reading-images:IMG_74552.JPG",
  • "Language": "en",
  • "User_BirthDate": "1980-05-20 10:22",
  • "User_Gender": "Female",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000",
  • "User_Name": "Jane Doe",
  • "User_Status": "Single"
}

Response samples

Content type
application/json
{
  • "Coffee_Reading": "Your future looks bright, with lots of interesting events.",
  • "User_ID": "c9bf9e5a-1685-4c89-bafb-ff5af830be8a"
}

TarotService

Provides a tarot card reading based on user's input

Request Body schema: application/json
required
First_Or
integer <int32> (User's Selected 1st Card Orientation (0: for Straight, 1: for Reversed))
Language
string (User Preferred Language Code (ISO 639-1 standard) (en: for english, fa: for Persian, ar: for Arabic, tr: for Turkish))
Sec_Or
integer <int32> (User's Selected 2nd Card Orientation (0: for Straight, 1: for Reversed))
Thr_Or
integer <int32> (User's Selected 3rd Card Orientation (0: for Straight, 1: for Reversed))
User_BirthDate
string (User Birth Date and Time from Profile in YYYY/MM/DD HH:MM format (ISO 8601 standard))
User_Gender
string (User's Gender from profile)
User_ID
string (Unique User ID (ISO/IEC 11578:1996 standard)-(128-bit label, 32 digit))
User_Name
string (User's Full Name from profile)
User_Ques
string (User's Input Question String asked from Tarot Cards)
User_Status
string (User's Martial Status from profile)
User_first_card
integer <int32> (User's Selected 1st Card Number (1~77))
User_sec_card
integer <int32> (User's Selected 2nd Card Number (1~77))
User_thrd_card
integer <int32> (User's Selected 3rd Card Number (1~77))

Responses

Request samples

Content type
application/json
{
  • "First_Or": 0,
  • "Language": "fa",
  • "Sec_Or": 1,
  • "Thr_Or": 0,
  • "User_BirthDate": "1990-01-25 13:15",
  • "User_Gender": "Male",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000",
  • "User_Name": "Jone Doe",
  • "User_Ques": "Should I invest all my money on Bitcoin?",
  • "User_Status": "Single",
  • "User_first_card": 27,
  • "User_sec_card": 42,
  • "User_thrd_card": 77
}

Response samples

Content type
application/json
{
  • "Tarot_FirstCard": "Tarot First Card Fortune Goes Here",
  • "Tarot_Fortune": "Tarot Overall Fortune Goes Here",
  • "Tarot_SecondCard": "Tarot Second Card Fortune Goes Here",
  • "Tarot_ThirdCard": "Tarot Third Card Fortune Goes Here",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000"
}

NumerologyService

Gives a numerology reading based on the user's birth date and name

Request Body schema: application/json
required
Language
string (User Preferred Language Code (ISO 639-1 standard) (en: for english, fa: for Persian, ar: for Arabic, tr: for Turkish))
User_BirthDate
string (User Birth Date and Time from Profile in YYYY-MM-DD HH:MM format (ISO 8601 standard))
User_ID
string (Unique User ID (ISO/IEC 11578:1996 standard)-(128-bit label, 32 digit))
User_Name
string (User's Full Name from profile)

Responses

Request samples

Content type
application/json
{
  • "Language": "en",
  • "User_BirthDate": "1980-11-25 17:45",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000",
  • "User_Name": "Jane Doe"
}

Response samples

Content type
application/json
{
  • "Destiny_Num": 2,
  • "Destiny_Number_desc": "Destiny Number Description Goes Here",
  • "Heart_Desire_Num": 5,
  • "Heart_Desire_Number_desc": "Heart Desire Number Description Goes Here",
  • "Life_Path_Num": 7,
  • "Life_Path_Number_desc": "Life Path Number Description Goes Here",
  • "Personality_Num": 11,
  • "Personality_Number_desc": "Personality Number Description Goes Here",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000"
}

NumCompatibilityService

Provides a numerology compatibility report for two individuals

Request Body schema: application/json
required
Language
string (User Preferred Language Code (ISO 639-1 standard) (en: for english, fa: for Persian, ar: for Arabic, tr: for Turkish))
User_BirthDate_1
string (User Birth Date and Time from Profile in YYYY-MM-DD HH:MM format (ISO 8601 standard))
User_BirthDate_2
string (User input Birth Date and Time in YYYY-MM-DD HH:MM format (ISO 8601 standard))
User_ID
string (Unique User ID (ISO/IEC 11578:1996 standard)-(128-bit label, 32 digit))
User_Name_1
string (User's Full Name from profile)
User_Name_2
string (User's Entered Full Name as Second Person)

Responses

Request samples

Content type
application/json
{
  • "Language": "en",
  • "User_BirthDate_1": "1980-11-25 17:45",
  • "User_BirthDate_2": "1990-08-15 14:35",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000",
  • "User_Name_1": "Jane Doe",
  • "User_Name_2": "Jone Doe"
}

Response samples

Content type
application/json
{
  • "Compatibility_report": "Numerology Compatibility Report Goes Here",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000"
}

ZodiacService

Calculates and returns the user's zodiac sign and related information

Request Body schema: application/json
required
Language
string (User Preferred Language Code (ISO 639-1 standard) (en: for english, fa: for Persian, ar: for Arabic, tr: for Turkish))
User_BirthDate
string (User Birth Date and Time from Profile in YYYY-MM-DD HH:MM format (ISO 8601 standard))
User_ID
string (Unique User ID (ISO/IEC 11578:1996 standard)-(128-bit label, 32 digit))

Responses

Request samples

Content type
application/json
{
  • "Language": "en",
  • "User_BirthDate": "1990-01-25 13:15",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/json
{
  • "User_High_Vib": "User High Vibration Goes Here",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000",
  • "User_Low_Vib": "User Low Vibration Goes Here",
  • "Zodiac_Category": "Zodiac Category Goes Here",
  • "Zodiac_Desc": "Zodiac Overall Description Goes Here",
  • "Zodiac_Element": "Zodiac Element Goes Here",
  • "Zodiac_Sign": "Zodiac Sign Name Goes Here"
}

NatalService

Generates a natal chart based on user's birth details

Request Body schema: application/json
required
Language
string (User Preferred Language Code (ISO 639-1 standard) (en: for english, fa: for Persian, ar: for Arabic, tr: for Turkish))
User_BirthCity
string (User's Birth Location (City) from Profile)
User_BirthDate
string (User Birth Date and Time from Profile in YYYY-MM-DD HH:MM format (ISO 8601 standard))
User_ID
string (Unique User ID (ISO/IEC 11578:1996 standard)-(128-bit label, 32 digit))
User_Name
string (User's Full Name from profile)

Responses

Request samples

Content type
application/json
{
  • "Language": "en",
  • "User_BirthCity": "London",
  • "User_BirthDate": "1990-08-15 14:35",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000",
  • "User_Name": "Jane Doe"
}

Response samples

Content type
application/json
{
  • "Natal_Chart": "urn:minio:falomen-ai:charts/Natal/c9bf9e57-1685-4c89-bafb-ff5af830be8a_Natal_20240112113418_25fc3a98-ae69-400d-81f4-37b198daaae0.svg",
  • "Natal_Chart_Brief": "Birth Chart Analysis Report Goes Here",
  • "Natal_Radar_Chart": "urn:minio:falomen-ai:charts/Natal/c9bf9e57-1685-4c89-bafb-ff5af830be8a_Natal_20240112113418_25fc3a98-ae69-400d-81f4-37b198daaae0.svg",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000"
}

TransitService

Creates a transit chart for a user for a specific date and location

Request Body schema: application/json
required
Language
string (User Preferred Language Code (ISO 639-1 standard) (en: for english, fa: for Persian, ar: for Arabic, tr: for Turkish))
UserID
string (Unique User ID (ISO/IEC 11578:1996 standard)-(128-bit label, 32 digit))
User_BirthCity_1
string (User's Birth Location (City) from Profile)
User_BirthCity_2
string (User's Entered Location (City))
User_BirthDate_1
string (User Birth Date and Time from Profile in YYYY-MM-DD HH:MM format (ISO 8601 standard))
User_BirthDate_2
string (User input Birth Date and Time in future in YYYY-MM-DD HH:MM format (ISO 8601 standard))
User_Name_1
string (User's Full Name from profile)

Responses

Request samples

Content type
application/json
{
  • "Language": "en",
  • "User_BirthCity_1": "London",
  • "User_BirthCity_2": "Tehran",
  • "User_BirthDate_1": "1970-11-20 16:55",
  • "User_BirthDate_2": "1990-01-25 13:15",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000",
  • "User_Name_1": "Jone Doe"
}

Response samples

Content type
application/json
{
  • "Transit_Chart": "urn:minio:falomen-ai:charts/Transit/c9bf9e5a-1685-4c89-bafb-ff5af830be8a_Transit_20240112100907_53ca9875-0407-4b04-8f8d-20c441782434.svg",
  • "Transit_Radar_Chart": "urn:minio:falomen-ai:charts/Transit/c9bf9e5a-1685-4c89-bafb-ff5af830be8a_Transit_20240112100907_53ca9875-0407-4b04-8f8d-20c441782434.svg",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000"
}

CompositeService

Creates a Composite chart for two person

Request Body schema: application/json
required
Language
string (User Preferred Language Code (ISO 639-1 standard) (en: for english, fa: for Persian, ar: for Arabic, tr: for Turkish))
User_BirthCity_1
string (User's Birth Location (City) from Profile)
User_BirthCity_2
string (User's Entered Birth Location (City) for Second Person)
User_BirthDate_1
string (User Birth Date and Time from Profile in YYYY-MM-DD HH:MM format (ISO 8601 standard))
User_BirthDate_2
string (User input Birth Date and Time in YYYY-MM-DD HH:MM format (ISO 8601 standard))
User_ID
string (Unique User ID (ISO/IEC 11578:1996 standard)-(128-bit label, 32 digit))
User_Name_1
string (User's Full Name from profile)
User_Name_2
string (User's Entered Full Name for Second Person)

Responses

Request samples

Content type
application/json
{
  • "Language": "en",
  • "User_BirthCity_1": "New York",
  • "User_BirthCity_2": "Los Angeles",
  • "User_BirthDate_1": "1980-05-20 10:22",
  • "User_BirthDate_2": "1990-08-15 14:35",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000",
  • "User_Name_1": "Jane Doe",
  • "User_Name_2": "Jane Doe"
}

Response samples

Content type
application/json
{
  • "Composite_Chart": "urn:minio:falomen-ai:charts/Composite/c9bf9e5a-1685-4c89-bafb-ff5af830be8a_Composite_20240112103825_a89c84a6-0499-4f0f-9b04-47bb642d0705.svg",
  • "Composite_Radar_Chart": "urn:minio:falomen-ai:charts/Composite/c9bf9e5a-1685-4c89-bafb-ff5af830be8a_Composite_20240112103825_c5340f9c-f695-4a59-9555-cd9c38c85ec9.svg",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000"
}

RelationshipScoreService

Calculates a relationship score based on natal charts of two individuals

Request Body schema: application/json
required
Language
string (User Preferred Language Code (ISO 639-1 standard) (en: for english, fa: for Persian, ar: for Arabic, tr: for Turkish))
User_BirthCity_1
string (User's Birth Location (City) from Profile)
User_BirthCity_2
string (User's Entered Birth Location (City) for Second Person)
User_BirthDate_1
string (User Birth Date and Time from Profile in YYYY-MM-DD HH:MM format (ISO 8601 standard))
User_BirthDate_2
string (User input Birth Date and Time in YYYY-MM-DD HH:MM format (ISO 8601 standard))
User_ID
string (Unique User ID (ISO/IEC 11578:1996 standard)-(128-bit label, 32 digit))
User_Name_1
string (User's Full Name from profile)
User_Name_2
string (User's Entered Full Name for Second Person)

Responses

Request samples

Content type
application/json
{
  • "Language": "en",
  • "User_BirthCity_1": "London",
  • "User_BirthCity_2": "New York",
  • "User_BirthDate_1": "1980-11-25 17:45",
  • "User_BirthDate_2": "1990-01-25 13:15",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000",
  • "User_Name_1": "Jane Doe",
  • "User_Name_2": "Jone Doe"
}

Response samples

Content type
application/json
{
  • "RelationshipScore": 45,
  • "Score_Desc": "RelationShip Score Description Goes Here",
  • "UserID": "123e4567-e89b-12d3-a456-426614174000"
}

DreamService

Provides analysis of a user's dream description

Request Body schema: application/json
required
Language
string (User Preferred Language Code (ISO 639-1 standard) (en: for english, fa: for Persian, ar: for Arabic, tr: for Turkish))
User_Dream
string (User's Input Dream Text)
User_ID
string (Unique User ID (ISO/IEC 11578:1996 standard)-(128-bit label, 32 digit))

Responses

Request samples

Content type
application/json
{
  • "Language": "en",
  • "User_Dream": "User Dream Text Goes Here",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/json
{
  • "Dream_Analysis": "Cream Analysis Report Goes Here",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000"
}

GenieService

Delivers a daily fortune based on the user's birth date

Request Body schema: application/json
required
Language
string (User Preferred Language Code (ISO 639-1 standard) (en: for english, fa: for Persian, ar: for Arabic, tr: for Turkish))
User_BirthDate
string (User Birth Date and Time from Profile in YYYY-MM-DD HH:MM format (ISO 8601 standard))
User_ID
string (Unique User ID (ISO/IEC 11578:1996 standard)-(128-bit label, 32 digit))

Responses

Request samples

Content type
application/json
{
  • "Language": "en",
  • "User_BirthDate": "1990-08-15 14:35",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000"
}

Response samples

Content type
application/json
{
  • "Genie": "Daily Fortune Report Goes Here",
  • "User_ID": "123e4567-e89b-12d3-a456-426614174000"
}