Skip to main content
POST
Imports TikTok slideshow content into a new draft slideshow:
  • pulls TikTok slideshow slides (max 8)
  • extracts text overlays with vision OCR
  • maps extracted text into editable text elements
  • creates a Genviral draft slideshow using matching Pinterest images or your selected pack as backgrounds
  • deducts copy credits and auto-refunds on failure

Idempotency

Send a unique Idempotency-Key header for each import you intend to create. Retrying the same key with the same body replays the original completed operation. An uncertain or still-running import retains its claim: retry the same key and body rather than starting another import. When the header is omitted, Genviral derives a stable key from the credential and request body for backward compatibility, so an identical headerless request is treated as a retry rather than a new import.

Body Parameters

string
required
TikTok slideshow URL.
string (UUID)
Optional preview token returned by Preview TikTok Slideshow Copy. Accepted for compatibility; the canonical importer fetches the source URL again and reports used_cached_preview: false.
string
Optional slideshow title override (max 200 chars).
string (UUID)
Optional image pack ID to source background images.
string[]
Optional direct list of image URLs for backgrounds.
string
pinterest_deck automatically finds matching Pinterest backgrounds without a pack. pack_only uses exactly one of pack_id or pack_images. Omit this field for existing pack-based requests. Automatic sourcing cannot be combined with either pack field.
string (UUID)
Optional product reference to attach to the created slideshow.
For pack backgrounds, provide exactly one of pack_id or pack_images. For automatic backgrounds, send image_sourcing: "pinterest_deck" without either pack field.

Example

Error Responses

  • 400 invalid_json - request body is not valid JSON
  • 422 invalid_payload - payload validation failed
  • 422 invalid_tiktok_url - URL is not valid TikTok
  • 422 not_slideshow - TikTok post is not a slideshow/photo post
  • 404 pack_not_found
  • 422 pack_empty
  • 422 pack_source_conflict - both pack_id and pack_images were sent
  • 404 product_not_found
  • 403 forbidden_product_access
  • 402 insufficient_credits - buy a credit pack at https://www.genviral.io/billing?tab=credits, then retry
  • 429 rate_limited
  • 502 tiktok_fetch_failed
  • 500 upstream_config_error - TikTok upstream credentials/config missing
  • 500 import_failed