Get-face-id | AstrologyAPI Developers

🌍 Astrocartography API and ✋ Palmistry API are now live. Ship them in your app today.Get Started

Get Face ID

POSThttps://vision.astrologyapi.com/face-reading/get-face-id

Copy

Scans a face image, stores extracted face-reading data, and returns a face_id used by all other face reading endpoints. Optional birth details may be sent with the image.

POST/face-reading/get-face-id

Copy

1curl --location 'https://vision.astrologyapi.com/face-reading/get-face-id' \
2  --header 'Content-Type: application/json' \
3  --header 'x-astrologyapi-key: <YOUR_ACCESS_TOKEN>' \
4  --data '{
5    "image_url": "https://sample-image.jpg",
6    "day": 15,
7    "month": 8,
8    "year": 1995,
9    "gender": "male"
10}'
11

200Response

Copy

1{
2  "status": true,
3  "message": "success",
4  "data": {
5    "face_id": "c48d0b80-1d49-4af8-8c05-e778b3d7a00f"
6  }
7}

Request Headers

x-astrologyapi-key

string

required

API Access Token to authenticate requests. Send your access token in this custom header.

Accept-Language

string

Preferred language for the response content

Properties

English - en

Request Body (JSON)

image_url

string

required

Public image URL or base64 data URL (data:image/...;base64,...) of the palm photo. Aliases: url, img_url, image. Accepted formats: jpeg, jpg, png, webp. Maximum size: 5MB.

day

number

Day of birth. If birth details are supplied, day, month, year, and gender must all be valid.

month

number

Month of birth.

year

number

Year of birth.

gender

string

Gender value used with optional birth details.

Properties

malefemaleother

Request Description

Submit a face image URL, base64 image, or uploaded image. Optional day, month, year, and gender can be supplied together.

Errors

400

Bad Request

Something is wrong with your request format or parameters.

401

Unauthorized

Your API key is missing or invalid.

403

Forbidden

You don't have permission to access this specific resource.

404

Not Found

The API endpoint you're trying to reach doesn't exist.

500

Internal Server Error

Our server is having a temporary glitch.

POST/face-reading/get-face-id

Copy

1curl --location 'https://vision.astrologyapi.com/face-reading/get-face-id' \
2  --header 'Content-Type: application/json' \
3  --header 'x-astrologyapi-key: <YOUR_ACCESS_TOKEN>' \
4  --data '{
5    "image_url": "https://sample-image.jpg",
6    "day": 15,
7    "month": 8,
8    "year": 1995,
9    "gender": "male"
10}'
11

200Response

Copy

1{
2  "status": true,
3  "message": "success",
4  "data": {
5    "face_id": "c48d0b80-1d49-4af8-8c05-e778b3d7a00f"
6  }
7}