Skip to main content
GET
/
v1
/
faces
/
{face_id}
/
neighbors
Get Face Neighbors
curl --request GET \
  --url https://api.faces.sh/v1/faces/{face_id}/neighbors
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

authorization
string | null

Path Parameters

face_id
string
required

Query Parameters

k
integer
default:5

Number of neighbors

Required range: 1 <= x <= 20
component
string
default:face

Centroid component

Pattern: ^(face|beta|delta|epsilon)$
direction
string
default:nearest

Search direction

Pattern: ^(nearest|furthest)$

Response

Successful Response