Upload family member palm image

POST

/api/v1/palm/family/{family_key}

palm

Last modified:2026-06-04 22:55:16

Upload a palm image for a specific family member (JPEG / PNG / WebP, max 5 MB). MediaPipe validates that a hand is present before saving. Analysis runs in the background - you will receive a push notification when ready.

Request: multipart/form-data | Bearer token

Body: file - palm/hand photo (JPEG/PNG/WebP, max 5 MB)

Success: 200 - image accepted and analysis started. Returns a confirmation message. Then poll GET /palm/family/{family_key}.

Errors:

401 - invalid/expired token

404 - family member not found for this user

409 - a palm analysis already exists for this member (pending/processing/done)

422 - no hand detected by MediaPipe, unsupported format, or file > 5 MB

Request

Path Params

Body Params multipart/form-dataRequired

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Successful Response

Bodyapplication/json

Example

{
    "success": true,
    "message": "Palm image uploaded. Analysis started. We'll notify you when ready."
}

🟠401Unauthorized

🟠404Record Not Found

🟠409Parameter Error

🟠422Parameter Error

Modified at 2026-06-04 22:55:16

Upload user palm image

Get family member palm reading