Developers

Personade API

Build a personalized video for every row in your table, in your own voice, and get back a link you can send.

Reference

Versioning

The version is in the path, and /v1 is a promise about what will not break under you. This page says exactly how far that promise goes, because a version number on its own does not say anything.

What will not change

Inside /v1, none of these will change. If one has to, it becomes /v2 and /v1 keeps working.

  • An endpoint's path, method, or what it does.
  • The name, type and meaning of any field currently in a response. Nothing that exists will be renamed, retyped, or quietly repurposed.
  • The name and meaning of any request field, and which are required.
  • Any error code, and the HTTP status it comes with.
  • The values of status on a campaign or a person. Their meanings are fixed.

What can change

These can change in /v1, without notice. Write your integration so none of them can break it.

  • New fields appearing in a response. Ignore what you do not recognise rather than failing on it. This is the one that catches people: a strict schema that rejects unknown keys will break the first time we add one.
  • New endpoints, and new optional request fields.
  • New values in an open-ended set: a new render stage in stages, or a new blockedReason sentence. Both are for showing a person, not for branching on.
  • The wording of any human-readable message, including message on an error, nextStep, and the stalled text. Branch on the code, show the sentence.
  • Limits, in either direction. The Limits page is the current numbers, not a contract.

Changelog

Per-person ids, links up front, and per-person calls to action

POST /leads now returns each person's id and their page URL, live before the video exists. GET /v1/leads/{id} answers about one person. ctaLabel, ctaUrl and headline set that person's own button and headline, merging over the recording's. Re-adding somebody returns the person they already are rather than an empty list. All additive: a caller sending none of it behaves exactly as before.

v1 published

Nine endpoints: templates, campaigns, leads, estimate, preview, generate, status, videos and stop. Same keys as the agent (MCP) surface.

Start building

Tell us before we break something

If you are building on this, email support@personade.com so you are on the list we warn first.

Get an API keyBook a call