Biduma

API

Loading

Biduma render API

Submit personalized reminder renders, poll their status, and download finished videos — everything this dashboard does is available over HTTP. The OpenAPI 3.1 spec imports directly into Postman, Insomnia, or any client generator.

Base URL

https://YOUR_BIDUMA_HOST

All endpoints live under this origin. In Postman or Insomnia, import the downloaded biduma-openapi.json and every request below appears ready to send.

Authentication

Every request needs a team token (they start with bdt_). Send it as the x-biduma-token header, or as Authorization: Bearer <token>. Tokens are created by an admin — ask your admin to issue you a bdt_ token.

Quickstart — render a video end to end

1List presets

A render is a character (presenter + voice) + a company (brand) + a CTA overlay. Pick a template preset id, a saved bundle of those, or note a companyId/ctaId to compose directly. GET /api/character lists the characters you can use.

List presets
curl 'https://YOUR_BIDUMA_HOST/api/presets' \
  -H 'x-biduma-token: YOUR_API_TOKEN'

2Submit a render

Returns 202 with a job id. Any of characterId, companyId or ctaId in the body override the template; only the borrower name and loan number appear in the video.

Submit a render
curl -X POST 'https://YOUR_BIDUMA_HOST/api/render/preset' \
  -H 'x-biduma-token: YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "templateId": "TEMPLATE_PRESET_ID",
    "characterId": "rohan",
    "customData": {
      "borrowerDisplayName": "Kamal Kishor",
      "loanDisplay": "2301458796"
    }
  }'

3Poll job status

Repeat until status is "done", "failed", or "canceled". When status is "done", check qualitySummary.ready: false means the render finished but the quality gate blocked it (not downloadable) — read qualitySummary for why.

Poll job status
curl 'https://YOUR_BIDUMA_HOST/api/jobs/JOB_ID' \
  -H 'x-biduma-token: YOUR_API_TOKEN'

4Download the video

The quality gate must be ready before the download is allowed.

Download the video
curl -L -o render.mp4 'https://YOUR_BIDUMA_HOST/download/JOB_ID' \
  -H 'x-biduma-token: YOUR_API_TOKEN'

Endpoint reference

Generated live from the OpenAPI spec — always in sync with the running backend.

Loading API reference

Fetching the OpenAPI specification.

API tokens

Admin-managed

API tokens are created and revoked by an admin. Ask your admin to issue you a bdt_ token, then send it as the x-biduma-token header on your requests.