Quick Start

Everything you need to start generating videos with the Golpo REST API.

Auth header

x-api-key: YOUR_API_KEY

Content-Type

application/json

Best for

Server-to-server integrations, automation workflows, internal dashboards, partner apps

Prerequisites

Valid API plan · API key issued per workspace · HTTPS requests only

Your API base URL is provided when you create an API key in the dashboard. All requests must be made over HTTPS.

Endpoints

Five REST endpoints covering the full video lifecycle — generate, list, retrieve, update, and delete.

POST/api/v1/videos/generate

Generate a video from a prompt or script with customizable voice, visuals, music, and branding.

generate.js
import fetch from "node-fetch";

const API_KEY = "api-key"; // Replace with your Golpo API key

const payload = {
  prompt: "Explain the quarterly roadmap",
  bg_music: "engaging"
};

const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key
const response = await fetch(`${BASE_URL}/api/v1/videos/generate`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": API_KEY
  },
  body: JSON.stringify(payload)
});

const data = await response.json();
console.log(data);

Run with: node --env-file=.env generate.js

GET/api/v1/videos

Retrieve videos belonging to the authenticated user. Supports limit and offset query params.

list-videos.js
import fetch from "node-fetch";

const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key

// Query params:
//   limit  — max number of videos to return (optional)
//   offset — number of videos to skip (optional, for pagination)
const response = await fetch(`${BASE_URL}/api/v1/videos?limit=10&offset=0`, {
  headers: {
    "x-api-key": "api-key"
  }
});

const data = await response.json();
console.log(data.videos); // array of video objects
console.log(data.total);  // total number of videos

Run with: node --env-file=.env list-videos.js

GET/api/v1/videos/{video_id}

Retrieve metadata for a single video by ID.

get-video.js
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key
const VIDEO_ID = "video_id";

const response = await fetch(`${BASE_URL}/api/v1/videos/${VIDEO_ID}`, {
  headers: { "x-api-key": "api-key" }
});
console.log(await response.json());

Run with: node --env-file=.env get-video.js <video_id>

PATCH/api/v1/videos/{video_id}

Update video metadata. Only 'title' and 'is_public' can be updated.

update-video.js
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key
const VIDEO_ID = "video_id";

const payload = { title: "Updated internal briefing" };

const response = await fetch(`${BASE_URL}/api/v1/videos/${VIDEO_ID}`, {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": "api-key"
  },
  body: JSON.stringify(payload)
});

console.log(await response.json());

Run with: node --env-file=.env update-video.js <video_id>

DELETE/api/v1/videos/{video_id}

Delete a generated video.

delete-video.js
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key
const VIDEO_ID = "video_id";

const response = await fetch(`${BASE_URL}/api/v1/videos/${VIDEO_ID}`, {
  method: "DELETE",
  headers: { "x-api-key": "api-key" }
});

console.log(await response.json());

Run with: node --env-file=.env delete-video.js <video_id>

GET/api/v1/videos/status/{job_id}

Poll the status endpoint to track generation progress.

job-status.js
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key
const JOB_ID = "job-id";

const response = await fetch(`${BASE_URL}/api/v1/videos/status/${JOB_ID}`, {
  headers: { "x-api-key": "api-key" }
});
console.log(await response.json());

Run with: node --env-file=.env job-status.js <job_id>

Request Body

Full parameter reference for POST /api/v1/videos/generate.

Either prompt or audio_clip is required. All other parameters are optional.
ParameterTypeDefaultRequiredDescription
promptstringRequired
Main prompt/script for the video
upload_urlsarray[string]NoneOptional
URLs of uploaded documents/images or local file paths. Use /upload-file endpoint to get URLs, or provide local paths directly
voice_instructionsstring""Optional
Describe how the narration voice should sound — accent, tone, pace, and delivery style.
Examples: "Speak in a warm British accent with a calm, professorial tone", "Fast-paced sports commentator style".
just_return_scriptbooleanfalseOptional
Only generate script, don't create video/podcast
new_scriptstringNoneOptional
Use your own script instead of generating one. Useful for creating a video or podcast from an existing script.
stylestring"solo-female-3"Optional
Content/Narration Style
Accepted values: "solo-female-3" (Female 1, default), "solo-female-4" (Female 2), "solo-male-3" (Male 1), "solo-male-4" (Male 2).
use_colorbooleantrueOptional
Enable color video generation
languagestring"en"Optional
Language code (e.g., 'en', 'es')
display_languagestringNoneOptional
Language for on-screen text in the video (e.g., 'English', 'Hindi', 'French'). Useful when the displayed text should differ from the narration language. Defaults to the value of language if omitted.
Example: language: "Hindi", display_language: "English" — the narrator speaks in Hindi while all on-screen text, titles, and labels are shown in English.
bg_musicstringNoneOptional
Background music track
video_typestring"long"Optional
Video type: 'long' (horizontal) or 'short' (vertical)
audio_onlybooleanfalseOptional
If true, generate podcast/audio only (no video)
timingstringNoneOptional
Video/Podcast timing/duration in minutes (numeric) or 'auto' to let the system determine duration
Examples: timing: 0.25 (15s), timing: 0.5 (30s), timing: 1 (1 min), timing: 2 (2 min), timing: 4 (4 min), timing: "auto" (system-determined).
include_watermarkbooleanfalseOptional
Include watermark in video
logostringNoneOptional
Custom logo for branding. Provide a URL (via /upload-file) or a local file path
logo_placementstring"tl"Optional
Controls where the logo is placed on the video when logo is provided and include_watermark is true. Valid values: 'tl' (top-left, default), 'tr' (top-right), 'bl' (bottom-left), 'br' (bottom-right).
video_instructionsstring""Optional
Visual instructions to guide how the video looks.
Examples: "Show more graphs and charts", "Include more stock footage", "Use cinematic transitions", "Dark moody aesthetic with neon accents".
use_lineart_2_stylestring"false"Optional
Golpo Sketch style selector. "false" (Classic, default), "true" (Improved), "advanced" (Formal).
NOTE:Do not use this when use_2_0_style is enabled (Golpo Canvas).
audio_clipstringNoneOptional
URL to audio/video file or local file path to use instead of generating script and TTS. Use /upload-file endpoint to get URLs, or provide local paths directly.
Useful for generating a video from your own existing audio or video narration.
user_audio_in_videoarray[integer]NoneOptional
List of video numbers that should use AI-generated narration audio instead of their original audio (e.g., [1, 3] means videos 1 and 3 get AI narration; unlisted user videos keep their original audio)
Only applies when user_videos is provided. Videos in this list will use AI-generated audio instead of original audio. Videos not in this list keep their original audio. If omitted or empty, all user videos retain their original audio.
user_imagesarray[string]NoneOptional
List of image URLs or local file paths to insert into the video. Use /upload-file endpoint to get URLs, or provide local paths directly
user_images_descriptionsarray[string]NoneOptional
List of descriptions for user images (one per image)
Helps the AI understand what each image contains and where to place it in the video for the best visual context.
use_as_isarray[boolean]NoneOptional
List of booleans indicating whether to use images as-is without AI processing (one per image)
When true, the original image is used directly with no AI animation. When false, the AI generates an animated version of the image for the video.
skip_animationarray[boolean]NoneOptional
List of booleans indicating whether to skip animation for images (one per image)
When true, the image appears as a static frame with no drawing or transition animation. When false, the image gets animated transitions.
user_videosarray[string]NoneOptional
List of video URLs or local file paths to insert into the video. Use /upload-file endpoint to get URLs, or provide local paths directly
user_videos_descriptionarray[string]NoneOptional
List of descriptions for user videos (one per video)
Provides context to the AI about each video's content, helping it decide where and how to place each clip in the generated video.
is_publicbooleanfalseOptional
Whether the video should be public (true) or private (false). Public videos appear in the Golpo video gallery.
use_2_0_stylebooleanfalseOptional
Enable Golpo Canvas (Earlier Golpo 2.0) style video generation.
NOTE:Use image_style to set the visual style for Golpo Canvas — if not provided, the default style will be used. Do not pass use_lineart_2_style when this is enabled.
image_stylestringNoneOptional
Image style for Golpo Canvas (2.0): 'neon', 'whiteboard', 'modern_minimal', 'playful', 'technical', or 'editorial'.
NOTE:Only applicable for Golpo Canvas (use_2_0_style). Do not use with Golpo Sketch.
input_imagesarray[string]NoneOptional
List of input image URLs or local file paths for Golpo Canvas. Use this when you want to solve a problem visually or base the video on specific images — the video will be generated around the provided images.
NOTE:Only applicable for Golpo Canvas (use_2_0_style). Do not use with Golpo Sketch.
pen_stylestringNoneOptional
Pen cursor style: 'stylus', 'marker', or 'pen'.
NOTE:Only applicable for Golpo Canvas (use_2_0_style). Do not use with Golpo Sketch.
show_pencil_cursorbooleanfalseOptional
Show a pencil cursor during sketch animations. If enabled, set pen_style to choose the cursor appearance.
NOTE:Only applicable for Golpo Canvas (use_2_0_style). Do not use with Golpo Sketch.
pacingstring"normal"Optional
Pacing level: 'normal' (15s max per frame), 'fast' (10s max per frame). Works with both Golpo Sketch and Golpo Canvas.

Parameter Groups

Parameters organized by purpose for easier discovery.

Content

promptaudio_clipnew_scriptupload_urlsstyleinput_images

Audio

bg_musicuser_audio_in_video

Voice

voice_instructionslanguage

Visual

use_coloruse_lineart_2_styleuse_2_0_styleimage_styleuser_imagesuser_images_descriptionsuse_as_isskip_animationpen_styleshow_pencil_cursor

Video Assets

user_videosuser_videos_description

Duration

timingvideo_typeaudio_onlypacing

Branding

include_watermarklogologo_placement

Workflow

video_instructionsjust_return_scriptis_public

Upload File

Use /api/v1/videos/upload-file to get a hosted URL before calling /generate.

NOTE:Maximum file size is 15 MB. Requests with larger files will be rejected.
NOTE:Document URLs are single-use. When you pass a document URL (PDF, DOCX, TXT, etc.) from /upload-file into upload_urls, the file is permanently deleted from storage after its text is extracted during generation. The same URL cannot be reused for another video or podcast — you must upload the document again via /upload-file to get a fresh URL for each new generation.
Content-Type:multipart/form-data
FieldTypeRequiredDescription
fileFileYesSingle file to upload (file metadata is used to generate presigned URL)

Documents

PDF · DOCX · PPTX · TXT

Audio

MP3 · WAV · M4A · OGG

Video

MP4 · MOV · AVI · MKV

Images

JPG · PNG · GIF · WEBP

upload-response.json
// Response from POST /api/v1/videos/upload-file
{
  "upload_url":   "https://...",  // Presigned PUT URL — upload the file here
  "file_url":     "https://...",  // Pass this into /generate
  "content_type": "application/pdf"
}
upload-file.js
const API_KEY = "api-key";
const BASE_URL = "{BASE_URL}";

// Step 1: Get presigned URL
async function uploadFile(file) {
  const formData = new FormData();
  formData.append('file', file);

  const response = await fetch(`${BASE_URL}/api/v1/videos/upload-file`, {
    method: 'POST',
    headers: { 'x-api-key': API_KEY },
    body: formData
  });

  const { upload_url, file_url, content_type } = await response.json();

  // Step 2: Upload file to presigned URL
  await fetch(upload_url, {
    method: 'PUT',
    headers: { 'Content-Type': content_type },
    body: file
  });

  // Step 3: Return file_url for use in /generate
  return file_url;
}

// Usage
const fileInput = document.querySelector('#file-input');
const fileUrl = await uploadFile(fileInput.files[0]);
console.log('File uploaded, URL:', fileUrl);
// Use fileUrl in your /generate request

User Assets

Upload images or videos to embed directly into the generated video.

NOTE:user_images and user_videos accept the file_url returned by /upload-file. local_path is also accepted for server-side usage. Descriptions are strongly recommended for best visual results.
generate-with-user-assets.js
const API_KEY = "api-key";
const BASE_URL = "{BASE_URL}";

// Helper function to upload a file
async function uploadFile(file) {
  const formData = new FormData();
  formData.append('file', file);

  const response = await fetch(`${BASE_URL}/api/v1/videos/upload-file`, {
    method: 'POST',
    headers: { 'x-api-key': API_KEY },
    body: formData
  });

  const { file_url } = await response.json();
  return file_url;
}

// Step 1: Upload images
const image1Url = await uploadFile(imageFile1);
const image2Url = await uploadFile(imageFile2);

// Step 2: Upload video
const video1Url = await uploadFile(videoFile1);

// Step 3: Generate video with user assets
const generatePayload = {
  prompt: "Create a product showcase video",
  user_images: [image1Url, image2Url],
  user_images_descriptions: [
    "Product front view with logo",
    "Product in use by customer"
  ],
  use_as_is: [false, false], // Process both images with AI
  skip_animation: [false, true], // Animate first image, skip animation for second
  user_videos: [video1Url],
  user_videos_description: ["Customer testimonial video"],
  video_type: "long",
  include_watermark: false
};

const generateResponse = await fetch(`${BASE_URL}/api/v1/videos/generate`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': API_KEY
  },
  body: JSON.stringify(generatePayload)
});

const result = await generateResponse.json();
console.log('Job ID:', result.job_id);

Local Paths

Pass absolute or relative file paths directly from server-side environments — no upload step required.

NOTE:Local paths are only supported in server-side environments where the API server has filesystem access.
generate-with-local-paths.js
import fetch from "node-fetch";
import path from "path";

const API_KEY = "api-key";
const BASE_URL = "{BASE_URL}";

// Example: Using local file paths (server-side only)
// Paths are relative to where the script runs or absolute paths
const payload = {
  prompt: "Create a comprehensive product demo video",
  upload_urls: [
    "./documents/product-spec.pdf",        // Relative path (Linux/Mac/Windows)
    "C:\\Users\\Documents\\brief.docx",  // Windows absolute path
    "/home/user/documents/slides.pptx",    // Linux/Mac absolute path
    "~/Documents/research.txt"             // Home directory expansion (Linux/Mac)
  ],
  logo: "./assets/company-logo.png",
  user_images: [
    "./images/product-front.jpg",
    "./images/product-in-use.jpg"
  ],
  user_images_descriptions: [
    "Product front view with branding",
    "Product being used by customer"
  ],
  use_as_is: [false, false],
  skip_animation: [false, true],
  style: "solo-female-3",
  bg_music: "engaging",
  video_type: "long",
  include_watermark: false,
  use_color: true,
  language: "en",
  timing: "5"
};

const response = await fetch(`${BASE_URL}/api/v1/videos/generate`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": API_KEY
  },
  body: JSON.stringify(payload)
});

const data = await response.json();
console.log("Job ID:", data.job_id);

Note: Local paths work when the API server can access these files. For remote clients, use /upload-file endpoint first.

Language Quickstarts

Ready-to-run examples for the most common video generation patterns.

Upload Workflow

Full pattern: upload supporting files, then generate a video in any language.

generateVideoWithUploads.js
const API_KEY = "api-key";
const BASE_URL = "{BASE_URL}";

// Step 1: Upload files
async function uploadFile(file) {
  const formData = new FormData();
  formData.append('file', file);

  const response = await fetch(`${BASE_URL}/api/v1/videos/upload-file`, {
    method: 'POST',
    headers: { 'x-api-key': API_KEY },
    body: formData
  });

  const { file_url } = await response.json();
  return file_url;
}

// Step 2: Upload all files and get URLs
const fileInput = document.querySelector('#uploads');
const uploadPromises = Array.from(fileInput.files).map(file => uploadFile(file));
const uploadUrls = await Promise.all(uploadPromises);

// Step 3: Generate video with uploaded files
const generatePayload = {
  prompt: 'Summarize this slide deck for executives',
  upload_urls: uploadUrls,
  style: 'professional',
  language: 'spanish'
};

const response = await fetch(`${BASE_URL}/api/v1/videos/generate`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': API_KEY
  },
  body: JSON.stringify(generatePayload)
});

const result = await response.json();
console.log('Generation started:', result);

Attach files via <input id="uploads" type="file" multiple /> before calling this helper.

Golpo Sketch

use_lineart_2_style

Whiteboard-style sketch animation with pacing control — normal (15s/frame) or fast (10s/frame).

golpo-sketch.js
import fetch from "node-fetch";

const API_KEY = "api-key"; // Replace with your Golpo API key
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key

const payload = {
  prompt: "Explain how neural networks work",
  use_lineart_2_style: "true", // Use "advanced" for the Formal Sketch style
  pacing: "normal",            // "normal" (15s max) or "fast" (10s max)
  bg_music: "engaging",
  include_watermark: false
};

const response = await fetch(`${BASE_URL}/api/v1/videos/generate`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": API_KEY
  },
  body: JSON.stringify(payload)
});

const data = await response.json();
console.log("Job ID:", data.job_id);

Run with: node --env-file=.env golpo-sketch.js

Golpo Canvas

use_2_0_style

Canvas-based video with rich image styles (neon, whiteboard, editorial…) and optional pencil cursor.

golpo-canvas.js
import fetch from "node-fetch";

const API_KEY = "api-key"; // Replace with your Golpo API key
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key

const payload = {
  prompt: "Create a product overview video",
  use_2_0_style: true,
  image_style: "modern_minimal", // "neon", "whiteboard", "modern_minimal", "playful", "technical", "editorial"
  include_watermark: false
};

const response = await fetch(`${BASE_URL}/api/v1/videos/generate`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": API_KEY
  },
  body: JSON.stringify(payload)
});

const data = await response.json();
console.log("Job ID:", data.job_id);

Run with: node --env-file=.env golpo-canvas.js

Display Language

Generate a video where the narration and the on-screen text are in different languages.

Display Language

display_language

Generate a video where the narration and the on-screen text are in different languages — e.g. Hindi voice-over with English text displayed in the video.

display-language.js
import fetch from "node-fetch";

const API_KEY = "api-key"; // Replace with your Golpo API key
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key

// The narrator speaks in Hindi, but all on-screen text,
// titles, and labels are displayed in English.
const payload = {
  prompt: "Explain the water cycle",
  language: "Hindi",         // Voice / narration language
  display_language: "English", // Language for on-screen text & visuals
  style: "educational",
  include_watermark: false
};

const response = await fetch(`${BASE_URL}/api/v1/videos/generate`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": API_KEY
  },
  body: JSON.stringify(payload)
});

const data = await response.json();
console.log("Job ID:", data.job_id);

Run with: node --env-file=.env display-language.js

Generate Video

POST /api/v1/videos/generate

Generate a video from a prompt or script with customizable voice, visuals, music, and branding.

generate.js
import fetch from "node-fetch";

const API_KEY = "api-key"; // Replace with your Golpo API key
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key

const payload = {
  prompt: "Explain the quarterly roadmap",
  bg_music: "engaging"
};

const response = await fetch(`${BASE_URL}/api/v1/videos/generate`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": API_KEY
  },
  body: JSON.stringify(payload)
});

const data = await response.json();
console.log(data);

Run with: node --env-file=.env generate.js

List Videos

GET /api/v1/videos

Retrieve videos belonging to the authenticated user. Supports limit and offset query params.

list-videos.js
import fetch from "node-fetch";

const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key

// Query params:
//   limit  — max number of videos to return (optional)
//   offset — number of videos to skip (optional, for pagination)
const response = await fetch(`${BASE_URL}/api/v1/videos?limit=10&offset=0`, {
  headers: {
    "x-api-key": "api-key"
  }
});

const data = await response.json();
console.log(data.videos); // array of video objects
console.log(data.total);  // total number of videos

Run with: node --env-file=.env list-videos.js

Get Video

GET /api/v1/videos/{video_id}

Retrieve metadata for a single video by ID.

get-video.js
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key
const VIDEO_ID = "video_id";

const response = await fetch(`${BASE_URL}/api/v1/videos/${VIDEO_ID}`, {
  headers: { "x-api-key": "api-key" }
});
console.log(await response.json());

Run with: node --env-file=.env get-video.js <video_id>

Update Video

PATCH /api/v1/videos/{video_id}

Update video metadata. Only 'title' and 'is_public' can be updated.

update-video.js
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key
const VIDEO_ID = "video_id";

const payload = { title: "Updated internal briefing" };

const response = await fetch(`${BASE_URL}/api/v1/videos/${VIDEO_ID}`, {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "x-api-key": "api-key"
  },
  body: JSON.stringify(payload)
});

console.log(await response.json());

Run with: node --env-file=.env update-video.js <video_id>

Delete Video

DELETE /api/v1/videos/{video_id}

Delete a generated video.

delete-video.js
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key
const VIDEO_ID = "video_id";

const response = await fetch(`${BASE_URL}/api/v1/videos/${VIDEO_ID}`, {
  method: "DELETE",
  headers: { "x-api-key": "api-key" }
});

console.log(await response.json());

Run with: node --env-file=.env delete-video.js <video_id>

Job Status

GET /api/v1/videos/status/{job_id}

Poll the status endpoint to track generation progress.

job-status.js
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key
const JOB_ID = "job-id";

const response = await fetch(`${BASE_URL}/api/v1/videos/status/${JOB_ID}`, {
  headers: { "x-api-key": "api-key" }
});
console.log(await response.json());

Run with: node --env-file=.env job-status.js <job_id>

Timing

Timing parameter reference — provide duration in minutes as a float, or "auto" to let the system determine the optimal duration.

ValueDuration
0.2515 seconds
0.530 seconds
11 minute
22 minutes
44 minutes
88 minutesBeta
1010 minutesBeta
"auto"System-determined
Supported values: 0.25, 0.5, 1, 2, 4, 8, 10, "auto".
When to use "auto" timing: Use auto timing when the content complexity should determine the video length. This is especially useful for problem-solving — for example, if you pass a math or physics problem via input_images, the engine will analyze the complexity and generate a script of the appropriate length (e.g., a simple problem may produce a 1-minute video, while a complex one may need 4+ minutes to explain thoroughly).

Example: Auto Timing with Problem Solving

Pass a problem image via input_images with Golpo Canvas and let the engine decide how long the explanation should be.

auto-timing-example.json
{
  "prompt": "Solve and explain this calculus problem step by step",
  "input_images": [
    "https://your-bucket.s3.amazonaws.com/calculus-problem.png"
  ],
  "use_2_0_style": true,
  "image_style": "whiteboard",
  "timing": "auto",
  "style": "solo-male-3",
  "video_type": "long"
}

Video Type

Controls the video aspect ratio and orientation.

ValueFormatDimensionsUse Cases
"short"Vertical / Portrait1024×1536 pxTikTok, Instagram Reels, YouTube Shorts
"long"Horizontal / Landscape (Default)1536×1024 pxYouTube, standard video content
9:16

short

1024×1536 px

16:9

long (default)

1536×1024 px

Style & Voices

The style parameter controls both script format and voice selection.

Voice Selection

ValueVoice TypeDescription
"solo-female-3"Female 1Female narrator voice (Default)
"solo-female-4"Female 2Alternative female narrator voice
"solo-male-3"Male 1Male narrator voice
"solo-male-4"Male 2Alternative male narrator voice

Background Music

Send the bg_music field in your JSON body using one of the following keys.

bg_music keyMood / Usage
"jazz"Warm, neutral bed
"lofi"Calm, study vibes
"whimsical"Playful, upbeat
"dramatic"Cinematic tension
"engaging"Subtle corporate pulse
"hyper"High-energy electronic
"inspirational"Uplifting orchestral
"documentary"Serious factual tone

Voice Instructions

Describe how the voice should sound — accent, tone, or pronunciation style.

Pass an instructions in the voice_instructions field to guide voice generation. The AI will adjust accent, tone, pace, and delivery accordingly.

voice-instructions-example.json
{
  "prompt": "Explain quantum computing basics",
  "voice_instructions": "Speak in a warm British accent with a calm, professorial tone. Pause slightly between key concepts for emphasis.",
  "style": "solo-male-3"
}

More examples

Talk in a French accent
Use an enthusiastic, energetic tone
Talk like a professor — measured and articulate
Speak slowly and clearly, like a meditation guide
Fast-paced sports commentator style
Friendly and casual, like chatting with a friend

Video Instructions

Describe how the video should look — visuals, style, and scene direction.

Pass an instructions in the video_instructions field to guide the visual generation. The AI will adjust scene composition, imagery, and visual style accordingly.

video-instructions-example.json
{
  "prompt": "Company quarterly results overview",
  "video_instructions": "Use clean corporate visuals with data charts and graphs. Include stock footage of modern office environments. Prefer blue and white color palette.",
  "style": "solo-female-3"
}

More examples

Show more graphs and charts
Include more stock footage
Use cinematic transitions
Female presenter in an office setting
Urban background with modern architecture
Dark moody aesthetic with neon accents

Golpo Sketch Styles

The use_lineart_2_style parameter controls the whiteboard sketch animation style.

ValueStyle NameDescription
"false"Classic (Default)Original Golpo Sketch — classic whiteboard line-art animation
"true"Improved BetaImproved line-art with cleaner strokes and a more polished look
"advanced"FormalAdvanced sketch generation with higher detail and refined aesthetics
Do not combine use_lineart_2_style with use_2_0_style. Use one or the other.

Golpo Canvas Styles

Enable Golpo Canvas with use_2_0_style and configure image_style and pen_style.

Set use_2_0_style: true to enable Golpo Canvas. Then use image_style to set the visual look and optionally pen_style to add a drawing cursor effect.

Pen Style

ValueDescription
"none"No pen cursor (Default)
"stylus"Thin stylus pen cursor
"marker"Thick marker cursor
"pen"Classic pen cursor
NOTE:pen_style and image_style are only applicable for Golpo Canvas (use_2_0_style: true). Do not use with Golpo Sketch.

Image Style

Controls the visual style of Golpo Canvas videos. Only applicable when use_2_0_style is true.

ValueLabelDescription
"chalkboard_white"Chalkboard (B/W)Black & white chalkboard style (Default)
"neon"Chalkboard ColorColorful neon chalkboard style
"whiteboard"WhiteboardClean whiteboard illustrations
"modern_minimal"Modern MinimalSleek, minimal modern aesthetic
"playful"PlayfulFun, colorful playful illustrations
"technical"TechnicalTechnical diagram style
"editorial"EditorialMagazine/editorial illustration style
"marker"SharpieBold marker/sharpie drawn style
golpo-canvas-example.json
{
  "prompt": "How solar panels convert sunlight to electricity",
  "use_2_0_style": true,
  "image_style": "modern_minimal",
  "pen_style": "stylus",
  "timing": 2
}

HTTP Status Codes

Standard HTTP codes returned by all endpoints.

CodeMeaningRecovery
200Successful request (GET, POST, PATCH, or DELETE)Consume response payload
400Bad request (invalid fields or file types)Check request body and field values
401Missing or invalid authenticationRefresh token / validate API key
403Plan does not allow requested actionUpgrade plan or contact support
404Video / job not foundVerify identifiers belong to the account
422Validation failure (bad payload)Inspect detail array in response
429Rate limit exceededBack off and retry with exponential delay
500Unexpected server errorRetry later; contact support if persistent

Error Response Format

All 4xx and 5xx responses return a JSON body with a detail field.

error-response.json
{
  "detail": "Invalid use_lineart_2_style. Supported values: 'true', 'false', 'advanced'."
}

For 4xx failures, inspect the detail field to surface error messages directly in your UI or logs.

Language Support

44+ languages supported via the language parameter.

LanguageAccepted valuesNote
Englishenglish or enDefault when omitted
Hindihindi or hi
Spanishspanish or es
Frenchfrench or fr
Germangerman or de
Italianitalian or it
Portugueseportuguese or pt
Russianrussian or ru
Japanesejapanese or ja
Koreankorean or ko
Chinese / Mandarinchinese, mandarin, or zhBoth map to zh
Arabicarabic or ar
Dutchdutch or nl
Polishpolish or pl
Turkishturkish or tr
Swedishswedish or sv
Danishdanish or da
Norwegiannorwegian or no
Finnishfinnish or fi
Greekgreek or el
Czechczech or cs
Hungarianhungarian or hu
Romanianromanian or ro
Thaithai or th
Vietnamesevietnamese or vi
Indonesianindonesian or id
Malaymalay or ms
Tamiltamil or ta
Telugutelugu or te
Bengalibengali or bn
Marathimarathi or mr
Gujaratigujarati or gu
Kannadakannada or kn
Malayalammalayalam or ml
Punjabipunjabi or pa
Urduurdu or ur
Usage-Based Plan

API Only Tier

Usage-based pricing with volume discounts

About this plan

This plan is for using Golpo within your program or application. You will not be able to use the Golpo platform to generate videos manually.

This is a usage-based plan with a minimum cost of $200 to enter. Perfect for developers and businesses who need programmatic access to video generation.

Pay only for what you use — volume-based pricing that gets better as you scale.

Platform access (manual video creation via the dashboard) is not included in this plan. If you need both platform + API access, please consider buying an enterprise plan or business plan with an API add-on.

Pricing Rates

Credit Conversion

$1

USD

1 Credit

Golpo credit

ResourceCost
1 min videoVideo generation2 Credits= $2.00

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

Minimum entry: $200 (200 credits = ~100 minutes of video)