Skip to main content
GET

Overview

Returns your team’s projects, newest first, with the total count for paging. Projects made through the API and projects made in the dashboard are both listed; templates are not. Each item is the same object Get Project returns: its status, progress, the metadata you sent, and its latest render under video (null until the render starts). Unlike List Videos, a project is listed from the moment it is created, so you can find one that is still generating or that failed before rendering.

Filtering by format

type takes the name of the create endpoint that made the project. Each project answers with its stored type, and that value works as a filter too. Projects of an older dashboard format (product_ads) are listed and can be filtered by their stored type. source=api keeps only the projects made through the API; source=web only the ones made in the dashboard (its automations included).

Paging

Pass limit (1 to 100, default 50) and offset. You have every project when offset + limit >= total. video.url is a signed link that expires: read the project again for a fresh one instead of storing it.

Errors

Authorizations

x-api-key
string
header
required

Query Parameters

status
enum<string>

Only projects in this state. Case-insensitive; any other value answers 400.

Available options:
draft,
processing,
completed,
failed
type
string
default:all

Only projects of this format, named by its create endpoint: add-captions, article-to-video, cinematic, clone-video, extend-video, hook-demo, music-to-video, pdf-to-brainrot, pdf-to-video, podcast-interview, prompt-to-video, quiz-video, reddit-story, remove-background, scenes, script-to-video, scrolling-video, talking-avatar, tiktok-slideshow, ugc-ads, ugc-studio. ugc-ads and ugc-studio are the same type (ugc_ads), so either lists both. The stored type a project answers with (script_to_video, caption_video, …) works too. all or left out: every type. Any other value answers 400.

source
enum<string>

Only projects made through the API (api) or in the dashboard (web). Both when left out; any other value answers 400.

Available options:
api,
web
limit
integer
default:50

Page size, 1 to 100. Larger values are capped at 100; missing or invalid values fall back to 50.

Required range: 1 <= x <= 100
offset
integer
default:0

Projects to skip. Missing or invalid values fall back to 0. You are done when offset + limit >= total.

Required range: x >= 0

Response

Projects

success
boolean
message
string
data
object