Documentation
Paramètres
Les paramètres de `GET /people` sont facultatifs. Les valeurs inconnues, répétées ou incompatibles sont rejetées.
Filtres disponibles
| Paramètre | Valeur | Rôle |
|---|---|---|
| count | 1–100 · défaut 1 | Nombre de profils |
| gender | male, female | Genre |
| ageGroup | child, teen, adult, senior | Un ou plusieurs groupes séparés par des virgules |
| nationality | Code ISO à deux lettres | Nationalité disposant d’un jeu de noms validé |
| residenceCountry | Code ISO à deux lettres | Pays contenant une ville disponible |
| continent | africa, americas, asia, europe, oceania | Limite les nationalités |
| city | Ville du pays de résidence | Nécessite un pays |
| emailDomain | Domaine ASCII · défaut example.test | Domaine des emails générés |
| portraitContexts | Liste séparée par des virgules ; vide = aucun portrait | Types : standard, doctor, construction, business, school-pupil |
| skinTone | Entiers distincts de 1 à 10, séparés par des virgules | Filtre les portraits portant une des teintes sélectionnées |
| seed | 1–128 caractères | Graine de génération |
| asOf | YYYY-MM-DD | Date de référence UTC |
| fields | Chemins séparés par des virgules | Sélection des champs renvoyés |
Groupes d’âge
Les groupes sont child (6–12 ans), teen (13–17), adult (18–64) et senior (65–100). Plusieurs valeurs distinctes peuvent être combinées : ageGroup=adult,senior.
Types de portraits et teint
Sur une API compatible, omettre portraitContexts sélectionne les cinq types publiés ; portraitContexts= exclut les portraits. Ces filtres s’appliquent aux images, pas à la génération du profil.
standard: 6–100 ans ;doctor: 25–64 ans ;constructionetbusiness: 18–64 ans ;school-pupil: 6–17 ans.- Plusieurs types sélectionnés combinent leurs âges admissibles. Le profil est quand même renvoyé si aucun portrait compatible n’est disponible ;
picturevaut alorsnull. skinToneaccepte des entiers distincts de 1 à 10, séparés par des virgules, et correspond à des annotations visuelles déjà validées. Il ne décrit pas l’ascendance ; les images non annotées ne correspondent pas au filtre.
Dans le Playground, les cinq cases commencent cochées. Décocher un type le retire de la requête ; tout décocher garde la sélection vide et ne réactive pas Standard. Les choix sont conservés dans l’URL. Sur une ancienne API, NEXT_PUBLIC_PERSONA_PORTRAIT_CONTEXTS_ENABLED=false masque ces cases et omet le paramètre.
Choisir les champs
fields sélectionne les propriétés de chaque personne. results et meta restent présents. Sans ce paramètre, tous les champs publics sont inclus sauf login, qui est facultatif.
GET /people?fields=name.first,location.city,location.coordinates.latitude,picture.thumbnailUne combinaison parent/enfant telle que name,name.first est rejetée avec le statut 400. La query string encodée est limitée à 2 048 caractères.