Quick Start
Everything you need to start generating videos with the Golpo REST API.
Auth header
x-api-key: YOUR_API_KEYContent-Type
application/jsonBest for
Server-to-server integrations, automation workflows, internal dashboards, partner apps
Prerequisites
Valid API plan · API key issued per workspace · HTTPS requests only
Endpoints
Five REST endpoints covering the full video lifecycle — generate, list, retrieve, update, and delete.
Submit a new video generation job with optional music, branding, and research controls.
import fetch from "node-fetch";
const API_KEY = "api-key"; // Replace with your Golpo API key
const payload = {
prompt: "Explain the quarterly roadmap",
add_music: true,
bg_volume: 0.3
};
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
Retrieve paginated videos belonging to the authenticated user.
import fetch from "node-fetch";
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key
const response = await fetch(`${BASE_URL}/api/v1/videos?limit=10`, {
headers: {
"x-api-key": "api-key"
}
});
const videos = await response.json();
console.log(videos);Run with: node --env-file=.env list-videos.js
Retrieve metadata for a single video by ID.
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 metadata. Only 'title' and 'is_public' can be updated.
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>
Soft delete a generated video (recoverable via support).
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>
Poll the status endpoint to track generation progress.
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.
prompt or audio_clip is required. All other parameters are optional.| Parameter | Type | Default | Required | Description |
|---|---|---|---|---|
| prompt | string | — | Required | Main prompt/script for the video |
| upload_urls | array[string] | None | Optional | URLs of uploaded documents/images or local file paths. Use /upload-file endpoint to get URLs, or provide local paths directly |
| add_music | boolean | false | Optional | Intro/outro music toggle |
| voice_instructions | string | "" | Optional | Instructions for voice generation |
| personality_1 | string | None | Optional | First personality for podcast |
| personality_2 | string | None | Optional | Second personality for podcast |
| just_return_script | boolean | false | Optional | Only generate script, don't create video/podcast |
| new_script | string | None | Optional | Use provided script instead of generating |
| do_research | boolean | false | Optional | Enable research for content generation |
| style | string | "solo-female" | Optional | Content/Narration Style |
| length | integer | None | Optional | Video length in seconds ('deprecated') |
| use_color | boolean | false | Optional | Enable color video generation |
| white_bg | boolean | true | Optional | Use white background |
| flat_background_color | boolean | false | Optional | Use flat background color |
| tts_model | string | "accurate" | Optional | Text-to-speech model |
| language | string | "en" | Optional | Language code (e.g., 'en', 'es') |
| bg_music | string | None | Optional | Background music track |
| bg_volume | float | 1.0 | Optional | Background music volume (0.0-1.0) |
| output_volume | float | 1.0 | Optional | Output audio volume (0.0-1.0) |
| video_type | string | "long" | Optional | Video type: 'long' or 'short' |
| audio_only | boolean | false | Optional | If true, generate podcast/audio only (no video) |
| timing | string | None | Optional | Video/Podcast timing/duration in minutes (must be numeric) |
| include_watermark | boolean | true | Optional | Include watermark in video |
| logo | string | None | Optional | Logo URL or local file path. Use /upload-file endpoint to get URLs, or provide local paths directly |
| logo_placement | string | "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). Logo is positioned with a 20-pixel margin from edges. |
| video_instructions | string | "" | Optional | Specific instructions for video generation |
| no_voice_chunking | boolean | true | Optional | Disable voice chunking |
| use_lineart_2_style | string | "false" | Optional | Golpo Sketch style selector. Supported: "false" (default), "true", "advanced". NOTE:Do not use this when use_2_0_style is enabled (Golpo Canvas). |
| audio_clip | string | None | Optional | 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 |
| user_audio_in_video | array[integer] | None | Optional | List of video numbers that should use their original audio (e.g., [1, 3] means videos 1 and 3 use original audio) |
| user_images | array[string] | None | Optional | 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_descriptions | array[string] | None | Optional | List of descriptions for user images (one per image) |
| use_as_is | array[boolean] | None | Optional | List of booleans indicating whether to use images as-is without AI processing (one per image) |
| skip_animation | array[boolean] | None | Optional | List of booleans indicating whether to skip animation for images (one per image) |
| user_videos | array[string] | None | Optional | 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_description | array[string] | None | Optional | List of descriptions for user videos (one per video) |
| is_public | boolean | None | Optional | Whether the video should be public (True) or private (False). If not provided, defaults to None. |
| use_2_0_style | boolean | false | Optional | 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_style | string | None | Optional | 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_images | array[string] | None | Optional | 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_style | string | None | Optional | 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_cursor | boolean | false | Optional | 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. |
| pacing | string | "normal" | Optional | Pacing level for Golpo sketch: 'normal' (15s max per frame), 'fast' (10s max per frame). NOTE:Only applicable for Golpo Sketch (use_lineart_2_style). Do not use with Golpo Canvas. |
Parameter Groups
Parameters organized by purpose for easier discovery.
Content
Audio
Voice
Visual
Video Assets
Duration
Branding
Workflow
Upload File
Use /api/v1/videos/upload-file to get a hosted URL before calling /generate.
multipart/form-data| Field | Type | Required | Description |
|---|---|---|---|
| file | File | Yes | Single 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
// 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"
}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 requestUser Assets
Upload images or videos to embed directly into the generated video.
user_images and user_videos accept the file_url returned by /upload-file. Descriptions are strongly recommended for best visual results.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.
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",
bg_music: "engaging",
bg_volume: 1.2,
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.
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,
add_music: true,
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_styleWhiteboard-style sketch animation with pacing control — normal (15s/frame) or fast (10s/frame).
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 advanced sketch style
pacing: "normal", // "normal" (15s max) or "fast" (10s max)
bg_music: "engaging",
bg_volume: 1.2,
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_styleCanvas-based video with rich image styles (neon, whiteboard, editorial…) and optional pencil cursor.
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
Generate Video
POST /api/v1/videos/generateSubmit a new video generation job with optional music, branding, and research controls.
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",
add_music: true,
bg_volume: 0.3
};
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/videosRetrieve paginated videos belonging to the authenticated user.
import fetch from "node-fetch";
const BASE_URL = "{BASE_URL}"; // You will receive this when creating an API key
const response = await fetch(`${BASE_URL}/api/v1/videos?limit=10`, {
headers: {
"x-api-key": "api-key"
}
});
const videos = await response.json();
console.log(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.
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.
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.
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.
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>
Uploads + Multi-language
Combine file uploads with video generation in any of the 44+ supported languages.
| Language | Example prompt |
|---|---|
| English (en) | Explain our Q3 product roadmap |
| Spanish (es) | Explica la hoja de ruta del producto del tercer trimestre |
| Hindi (hi) | तीसरी तिमाही के उत्पाद रोडमैप को समझाएं |
| French (fr) | Expliquez la feuille de route produit du troisième trimestre |
Set the language parameter to any supported value — e.g. en, es, hi, fr. See for all 44+ codes.
Timing
Timing parameter reference — provide duration in minutes as a float.
| Value | Duration |
|---|---|
| 0.25 | 15 seconds |
| 0.5 | 30 seconds |
| 1 | 1 minute |
| 2 | 2 minutes |
| 4 | 4 minutes |
| 8 | 8 minutesBeta |
| 10 | 10 minutesBeta |
0.25, 0.5, 1, 2, 4, 8, 10.Video Type
Controls the video aspect ratio and orientation.
| Value | Format | Dimensions | Aspect Ratio | Use Cases |
|---|---|---|---|---|
| "short" | Vertical / Portrait | 1024×1536 px | 9:16 | TikTok, Instagram Reels, YouTube Shorts |
| "long" | Horizontal / Landscape (Default) | 1536×1024 px | 16:9 | YouTube, standard video content |
short
1024×1536 px
long (default)
1536×1024 px
Style & Voices
The style parameter controls both script format and voice selection.
Script Format
| Value | Script Format | Requirements |
|---|---|---|
| "conversational" | Multi-speaker podcast (Default) | Requires personality_1 and personality_2 |
| Any other value | Single narrator format | — |
Voice Selection
| Value | Voice Type | Description |
|---|---|---|
| "conversational" | Multi-speaker voices | Uses Joe and Sarah voices |
| "solo-male" | Single male narrator | Single male narrator voice |
| "solo-male-2" | Single male narrator (alt) | Alternative single male narrator voice |
| "solo-female" | Single female narrator | Single female narrator voice |
| "solo-female-2" | Single female narrator (alt) | Alternative single female narrator voice |
video_type is set (not None) and style == "conversational", the system automatically converts style to "solo-female" before processing.style == "conversational" and generating a podcast (audio_only=true or video_type=None), the system ignores the provided timing parameter and generates the podcast “as long as needs be.” This can result in longer duration podcasts than specified.TTS Model
Choose the narration model — accurate is the default for highest quality.
| Value | Description |
|---|---|
| "accurate" | Highest quality narration with natural prosody; slightly slower and higher cost. (Default) |
| "flash" | Faster, lower-cost synthesis with a flatter delivery. Auto-fallback when accurate fails. |
accurate is treated as flash. Errors from accurate automatically retry with flash.Background Music
Send the bg_music field in your JSON body using one of the following keys.
| bg_music key | Mood / 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 a free-form string in the voice_instructions field to guide voice generation. The AI will adjust accent, tone, pace, and delivery accordingly.
{
"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"
}More examples
Video Instructions
Describe how the video should look — visuals, style, and scene direction.
Pass a free-form string in the video_instructions field to guide the visual generation. The AI will adjust scene composition, imagery, and visual style accordingly.
{
"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"
}More examples
Golpo Sketch Styles
The use_lineart_2_style parameter controls the whiteboard sketch animation style.
| Value | Style Name | Description |
|---|---|---|
| "false" | Classic (Default) | Original Golpo Sketch — classic whiteboard line-art animation |
| "true" | Improved Beta | Improved line-art with cleaner strokes and a more polished look |
| "advanced" | Formal | Advanced sketch generation with higher detail and refined aesthetics |
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
| Value | Description |
|---|---|
| "none" | No pen cursor (Default) |
| "stylus" | Thin stylus pen cursor |
| "marker" | Thick marker cursor |
| "pen" | Classic pen cursor |
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.
| Value | Label | Description |
|---|---|---|
| "chalkboard_white" | Chalkboard (B/W) | Black & white chalkboard style (Default) |
| "neon" | Chalkboard Color | Colorful neon chalkboard style |
| "whiteboard" | Whiteboard | Clean whiteboard illustrations |
| "modern_minimal" | Modern Minimal | Sleek, minimal modern aesthetic |
| "playful" | Playful | Fun, colorful playful illustrations |
| "technical" | Technical | Technical diagram style |
| "editorial" | Editorial | Magazine/editorial illustration style |
| "marker" | Sharpie | Bold marker/sharpie drawn style |
{
"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.
| Code | Meaning | Recovery |
|---|---|---|
| 200 | Successful GET, PATCH, or DELETE | Consume response payload |
| 201 | Video generation request accepted | Poll the status endpoint |
| 401 | Missing or invalid authentication | Refresh token / validate API key |
| 403 | Plan does not allow requested action | Upgrade plan or contact support |
| 404 | Video / job not found | Verify identifiers belong to the account |
| 422 | Validation failure (bad payload) | Inspect detail array in response |
| 429 | Rate limit exceeded | Back off and retry with exponential delay |
| 500 | Unexpected server error | Retry later; contact support if persistent |
Error Response Format
All 4xx and 5xx responses return a structured JSON body.
{
"message": "Validation error",
"detail": [
{
"loc": ["body", "prompt"],
"msg": "prompt cannot be empty when audio_clip is missing",
"type": "value_error"
}
]
}For 4xx failures, inspect the detail array to surface validation errors directly in your UI or logs.
Language Support
44+ languages supported via the language parameter.
| Language | Accepted values | Note |
|---|---|---|
| English | english or en | Default when omitted |
| Hindi | hindi or hi | — |
| Spanish | spanish or es | — |
| French | french or fr | — |
| German | german or de | — |
| Italian | italian or it | — |
| Portuguese | portuguese or pt | — |
| Russian | russian or ru | — |
| Japanese | japanese or ja | — |
| Korean | korean or ko | — |
| Chinese / Mandarin | chinese, mandarin, or zh | Both map to zh |
| Arabic | arabic or ar | — |
| Dutch | dutch or nl | — |
| Polish | polish or pl | — |
| Turkish | turkish or tr | — |
| Swedish | swedish or sv | — |
| Danish | danish or da | — |
| Norwegian | norwegian or no | — |
| Finnish | finnish or fi | — |
| Greek | greek or el | — |
| Czech | czech or cs | — |
| Hungarian | hungarian or hu | — |
| Romanian | romanian or ro | — |
| Thai | thai or th | — |
| Vietnamese | vietnamese or vi | — |
| Indonesian | indonesian or id | — |
| Malay | malay or ms | — |
| Tamil | tamil or ta | — |
| Telugu | telugu or te | — |
| Bengali | bengali or bn | — |
| Marathi | marathi or mr | — |
| Gujarati | gujarati or gu | — |
| Kannada | kannada or kn | — |
| Malayalam | malayalam or ml | — |
| Punjabi | punjabi or pa | — |
| Urdu | urdu or ur | — |
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, contact us.
Pricing Rates
Credit Conversion
$1
USD
1 Credit
Golpo credit
| Resource | Cost |
|---|---|
| 1 min videoVideo generation | 2 Credits= $2.00 |
Volume discounts apply at higher usage tiers. Contact us for enterprise rates. | |
Minimum entry: $200 (200 credits = ~100 minutes of video)