Posters and films
DocsGuidesPosters and films

Posters and films

Ask for the outcome you want in the same call as the scan, or make more later from the saved build.

Everything in one call

curl
curl -X POST https://spoken.fyi/api/v1/scan \
  -H "Authorization: Bearer $SPOKEN_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "job": "full", "photos": ["https://your-cdn.example/bike.jpg"], "poster_style": "annotated" }'

# → parts, a poster URL, and a film to collect when it is ready

job picks the outcome: bom (parts only), bom_poster, film or full (parts, poster and film). Each costs what it runs — see pricing.

More from a build you already have

POST /api/v1/builds/{id}/poster with a style makes another poster, and POST /api/v1/builds/{id}/film makes a new film. Neither pays to identify the parts again. Film remakes are limited to two per build per day.

Poster styles: annotated, portrait, spec, combo, scan, weights, blueprint, classic.

Collecting a film

A film takes a few minutes. Check GET /api/v1/builds/{id}/film — free — until the status is done and it carries video_url. If a render fails, its cost is credited back the next time you check.

Poster and film URLs are public and cached, so you can put them straight into an image or video tag.