Reference

API Docs

What each endpoint does, its parameters and example payloads, and exact setup steps for Postman or n8n.

Bearer revpeak

Connection basics

Base URL

https://video-api.revpeak.agency

Auth

Type: Bearer Token
Header: Authorization
Value: Bearer revpeak

Every endpoint below lists its parameters, an example payload, and exact setup steps for Postman and n8n. The dashboard's own "test it here" panel uses a same-origin proxy and doesn't need the key pasted in; external clients call https://video-api.revpeak.agency directly with the Bearer header above.

Create lead (URL)

POST /v1/leads

Auth required

Enqueue a personalized render from a public screenshot URL and a public base video URL. Idempotent on client + project + email + template.

Returns 202 for a new lead, 200 when replaying an identity you've already submitted.
Use Create lead (file) instead if you have the screenshot or base video bytes locally rather than already hosted somewhere.

Request body (JSON)

Field	Type	Required	Example / notes
email	string	yes	prospect@example.com · Prospect email
clientSlug	string	yes	acme-corp · Client slug
projectSlug	string	yes	q1-outbound · Project slug
screenshotUrl	string	yes	https://picsum.photos/1080/1920 · Public URL of the lead's screenshot
baseVideoUrl	string	yes	https://rp-base-videos.revpeak.marketing/acme-corp/q1-outbound/base.webm · Base overlay video URL for this client/project
leadId	string	no	Optional caller-supplied lead id (derived from email if omitted)
callbackUrl	string	no	https://example.com/hooks/render · Optional HTTPS webhook, called with the result on completion/failure
outputs	string	no	["short","gif","static"] · Which outputs to render. Defaults to "short", "gif", and "static".
templateVersion	string	no	v1 · Render template version, defaults to v1
outputVideoUrl	string	no	Optional exact destination URL for the short video (overrides the default path)
outputGifUrl	string	no	Optional exact destination URL for the gif (overrides the default path)
outputStaticUrl	string	no	Optional exact destination URL for the static PNG (overrides the default path)

Example request body

{
  "email": "prospect@example.com",
  "clientSlug": "acme-corp",
  "projectSlug": "q1-outbound",
  "screenshotUrl": "https://picsum.photos/1080/1920",
  "baseVideoUrl": "https://rp-base-videos.revpeak.marketing/acme-corp/q1-outbound/base.webm"
}

Example responses

202 · Accepted (new)

{
  "leadId": "prospect-a1b2c3d4e5f60718",
  "jobId": "cmrrw3w4u000001l1qauhlkqt",
  "status": "queued",
  "clientSlug": "acme-corp",
  "projectSlug": "q1-outbound",
  "email": "prospect@example.com",
  "ageSeconds": 0,
  "durationSeconds": null,
  "queuePosition": 1,
  "running": true,
  "complete": false,
  "screenshotUrl": "https://picsum.photos/1080/1920",
  "createdAt": "2026-07-19T14:27:29.262Z",
  "updatedAt": "2026-07-19T14:27:29.262Z",
  "startedAt": null,
  "completedAt": null
}

Set up in Postman

Create a new request: POST https://video-api.revpeak.agency/v1/leads
Authorization tab → Type "Bearer Token" → Token: your API key
Body tab → select "raw" → choose "JSON" → paste the example request body below
Send, and compare the response against the examples below.

Set up in n8n

Add an "HTTP Request" node
Set Method to POST
Set URL to https://video-api.revpeak.agency/v1/leads
Set Authentication to "Generic Credential Type" → "Header Auth" → create a credential named Authorization with value "Bearer <your API key>"
Turn on "Send Body" → Body Content Type "JSON" → "Specify Body" → "Using JSON" → paste the example request body below, swapping in expressions like {{ $json.email }} as needed

Test it here (optional)

Sends a real request through the dashboard's own proxy — useful for a quick check without leaving this page.