Skip to main content

Documentation Index

Fetch the complete documentation index at: https://acme-3f0e8fe2.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

A person is a reusable photo reference. Upload once, reference by ID or name in any render.

Why use People

Without People, you’d embed a photo URL in every modification:
{ "name": "avatar", "image_url": "https://cdn.example.com/jane.jpg" }
With People, you reference a stable identity:
{ "name": "avatar", "person_id": "per_jane123" }
Benefits:
  • Update the photo once, all future renders pick it up
  • Tag people with metadata (department, role, region) for filtered batch renders
  • Signed URLs are regenerated on demand — no broken links from expired CDNs

Lifecycle

  1. Upload photo via POST /v1/people with photo_asset_id from a prior /v1/assets upload
  2. Reference in renders by person_id or external name
  3. Update photo with PATCH /v1/people/<id>
  4. Soft-delete with DELETE /v1/people/<id>
See the API reference for people.