Golpo/API Reference

API Documentation

Everything you need to integrate Golpo's AI video generation into your application — REST endpoints, Python SDK, and Node.js SDK.

Explore REST APIPython SDKNode SDK

Choose your integration

v2v1

REST API

HTTP endpoints for video generation and status polling. Language-agnostic — use any HTTP client.

Quick links

v1.0.2v1.0.0

Python SDK

Official Python client for Golpo API. Synchronous and async support. Works with Python 3.8+.

Quick links

v1.0.2v1.0.0

Node SDK

Official TypeScript/JavaScript client for Golpo API. First-class types, Promise-based, ESM + CJS.

Quick links

Latest releaseREST API v2May 2026

REST API v2 introduces a clearer parameter set — golpo_video_engine with canvas_style_variant / sketch_style_variant, renamed fields like narration_voice, background_track, video_orientation, and new options like scene_pacing and PiP narration overlays.

Changelog

Release history for all SDKs and the REST API.

REST APIv1, v2May 2026

New style support — Creative, Infographics, Illustrations

  • Golpo Canvas engine now supports the Illustrations style — image_style: 'vox' (v1) or canvas_style_variant: 'illustrations' (v2).
  • Golpo Sketch engine now supports Creative and Infographics styles — use_lineart_2_style: 'creative' / 'vox' (v1) or sketch_style_variant: 'creative' / 'infographics' (v2).
REST APIv2May 2026

REST API v2 — Now Available

  • POST /api/v2/videos/generate — JSON body, x-api-key required
  • Renamed parameters for clarity: prompt, reference_source, narration_voice, narration_language, enable_color, enable_podcast_engine, enable_script_only_mode, custom_script, custom_logo, logo_position, watermark, background_track, video_orientation, own_narration_source, custom_images / custom_images_description, custom_videos / custom_videos_description, visibility, onscreen_text_language
  • New: golpo_video_engine selects 'golpo_canvas' or 'golpo_sketch'; canvas_style_variant and sketch_style_variant expose user-friendly preset names
  • New: own_narration_video_mode + own_narration_video_position for picture-in-picture narration overlays
  • New: scene_pacing ('normal' | 'fast'), pen_animation_style ('stylus' | 'marker' | 'pen')
  • PATCH /api/v2/videos/{video_id} restricted to title and visibility
  • use_ai_audio_at semantics inverted vs v1: list 1-indexed custom_videos positions whose original audio should be replaced with AI narration
  • /upload-file enforces a 15 MB max and is gated to Plus and above plans
Python SDKv1.0.2Apr 2026

Python SDK v1.0.2

  • user_audio_in_video now accepts List[int] — specify which user videos should be replaced with AI-generated narration audio (e.g., [1, 3] replaces audio on videos 1 and 3; unlisted user videos keep their original audio). Previously only accepted str. Note: use List[int] (e.g., [1, 2]) — do not use List[bool].
Python SDKv1.0.0Mar 2026

Python SDK v1.0.0 — Major Release

  • New update_video() method — update video metadata (prompt, context, scenes, frame animations)
  • Golpo Canvas support — use_2_style with 8 image styles: chalkboard_white, neon, whiteboard, modern_minimal, playful, technical, editorial, marker
  • Golpo Sketch modes — use_lineart_2_style with classic, improved (beta), and advanced styles plus pacing control
  • Pen styles — pen_style (stylus, marker, pen)
  • User media — user_images and user_videos with descriptions for custom content
  • display_language — independently control the language used for on-screen text, separate from the narration language
  • The following parameters are now deprecated and no longer supported: personality_1, personality_2, do_research, tts_model, bg_volume, output_volume, add_music, no_voice_chunking, max_workers
Node SDKv1.0.2Apr 2026

Node SDK v1.0.2

  • userAudioInVideo now accepts number[] — specify which user videos should be replaced with AI-generated narration audio (e.g., [1, 3] replaces audio on videos 1 and 3; unlisted user videos keep their original audio). Defaults to [] when userVideos is provided.
Node SDKv1.0.0Mar 2026

Node SDK v1.0.0 — Major Release

  • New parameter support added in createPodcast() — generate audio-only podcasts from prompts or documents
  • 21 new createVideo options: Golpo Sketch (useLineart2Style), Golpo Canvas (use2Style, imageStyle, penStyle), user assets (userImages, userVideos), videoInstructions, newScript, audioClip, pacing, and more
  • Updated voice styles: solo-female-3, solo-female-4, solo-male-3, solo-male-4
  • Expanded timing options: 0.25, 0.5, 1, 2, 4, 8, 10, 15 minutes
  • Background music expanded to 7 genres: jazz, lofi, dramatic, engaging, hyper, inspirational, documentary
  • Logo now supports both file paths and URLs
  • displayLanguage — independently control the language used for on-screen text, separate from the narration language
  • The following parameters are now deprecated and no longer supported: personality1, doResearch, ttsModel, bgVolume, outputVolume, concurrency
REST APIv1Mar 2026

Deprecated Parameters, Upload Limit & Auto Timing

  • The following parameters are now deprecated and no longer supported: personality_1, personality_2, do_research, length, white_bg, flat_background_color, tts_model, add_music, bg_volume, output_volume, no_voice_chunking
  • Upload file (/api/v1/videos/upload-file) now enforces a maximum file size of 15 MB
  • timing parameter now supports "auto" — the engine determines optimal video duration based on content complexity (ideal for problem-solving)
REST APIv1Mar 2026

Voice Style Options Updated

  • Removed "conversational" style — multi-speaker podcast format is no longer available via the API
  • New voice options: solo-female-3 (Female 1), solo-female-4 (Female 2), solo-male-3 (Male 1), solo-male-4 (Male 2)
  • Deprecated old voices: solo-male, solo-male-2, solo-female, solo-female-2
  • Default style is now "solo-female-3"
Python SDKv0.9.9Feb 2026

Python SDK v0.9.9 — Stable Release

  • Stable release with full API coverage
  • New parameters: use_color, video_instructions, output_volume
  • combine_videos() method added
  • create_video, get_frame_animations, edit_video, combine_videos
  • Async-first design with full sync wrappers
REST APIv1Jan 2026

REST API v1 — Generally Available

  • POST /api/v1/videos/generate — generate a new video job
  • POST /api/v1/videos/upload-file — upload a file (audio, video, or document) and get its URL
  • GET /api/v1/videos — retrieve videos for the authenticated user
  • GET /api/v1/videos/{video_id} — retrieve a specific video
  • PATCH /api/v1/videos/{video_id} — update video metadata (title, is_public)
  • DELETE /api/v1/videos/{video_id} — soft delete a video
  • GET /api/v1/videos/status/{job_id} — check status of a generation job
  • x-api-key header authentication for all endpoints

API Only Tier

Usage-based pricing with volume discounts.

This plan is for using Golpo within your program or application. You won't be able to generate videos manually via the Golpo dashboard.

Usage-based, with a minimum commitment of $200. Built for developers and businesses that need programmatic access at scale.

Platform access isn't included. For both platform and API access, consider an enterprise plan or a business plan with the API add-on.

Credit
$1 = 1 credit
1 min video
2 credits · $2.00
Minimum entry
$200 · ~100 min

Volume discounts at higher tiers. Contact us for enterprise rates.

Questions? Reach out at founders@golpoai.com

REST API v2Python SDKNode SDK