Skip to content
VividProp.io

API

The same pipeline, without the interface

Create a project, upload photos and poll a job from your own CRM or listing platform.

Not scheduled

Not scheduled. A public API waits until the credit ledger, idempotency and audit trail have been proven in the product.

Agencies with their own tooling should not copy photographs between two systems. The API exposes the pipeline the app uses — projects, uploads, jobs, credits — with scoped keys and organisation-level isolation.

How it is meant to work

01

Keys are scoped and revocable

A key belongs to one organisation and a narrow set of scopes. Revocation is immediate, and every call is attributable in the audit trail.

02

Idempotent by construction

Job creation takes an idempotency key. A retried request returns the original job instead of reserving a second time, which is the failure that makes credit APIs expensive.

03

Webhooks, not polling loops

Signed webhooks fire on job completion and failure. Polling is available as a fallback, rate-limited and documented.

Specification

Surface
REST over HTTPS, JSON, versioned path
Auth
Organisation-scoped bearer key, per-key scopes, 90-day rotation
Events
job.completed, job.failed, export.ready — HMAC signed
Status
Not scheduled — depends on a stable internal pipeline

Questions

Is there an API today?

No. There is no public endpoint, no key management and no webhook delivery. Any integration offered before that exists would be a promise, not a product.

Start with what exists

The workspace, the roles, the credit ledger and the invitation flow are live. Create the account now and be first in line when this milestone opens — no card is collected.