Skip to main content
POST
Adds a new member to a family you own, then regenerates the member’s portrait and the family’s group card_image_url. Only the family’s owner can add members.
Adding a family member requires a Pro, Max, or Enterprise plan, like all other family write operations.
The family must be in ready status: if another generation is already in progress for this family, the request is rejected with 422 FAMILY_NOT_READY. A family can have at most 6 members; adding a 7th is rejected with 422 FAMILY_MEMBER_LIMIT_EXCEEDED.

Path Parameters

string
required
The UUID of the family to add a member to. Only accepts families you own.Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Request Body

string
required
Broad age category.Allowed values: adult, child, seniorGuides how the member is depicted in generated scenes.
string
Short descriptive label for this member’s role in the family, e.g. father, mother, daughter, grandmother. This guides avatar generation and how the member is referred to internally.
string
Free-text age or age range to guide avatar generation, e.g. 5-7.
string
Free-text ethnicity to guide avatar generation.
string
Free-text physical description to guide avatar generation, e.g. short dark hair, bright smile.
string
Free-text clothing description to guide avatar generation, e.g. casual t-shirt and shorts.
string
HTTPS URL to receive a webhook notification when the new portrait finishes generating.See Webhooks for payload format and verification details.
Webhook URLs must use HTTPS and cannot point to private/internal networks (SSRF protection).
string
Optional idempotency key. Retrying a request with the same key returns the original result instead of adding a duplicate member.

Response

Returns a 202 Accepted response with a task to poll:
string
required
Unique identifier for the family.
string
required
Unique identifier for the generation task. Poll it via Get Task, or use webhook_url for a notification instead.
string
required
Always generating for this response shape.
boolean
required
true for live (vpk_live_) requests; false for test-mode (vpk_test_) requests. See Test Mode.
HATEOAS links for navigation.
  • self: URL to fetch the family (/v1/families/{family_id})
  • task: URL to poll for the generation task (/v1/tasks/{task_id})

Polling for Completion

Poll the returned task_id via Get Task. Once status is completed, Get Family reflects the new member, its portrait, and the regenerated group card_image_url. If the task fails, the family is left exactly as it was: the new member is not added and no existing assets are changed.

Error Codes

See Error Handling for more details.