Skip to main content
GET
List Projects
Returns a paginated list of all video ad projects created by the authenticated user. Results are sorted by creation date (newest first) and can be filtered by project status.

Authentication

This endpoint requires a valid API key with the projects:read permission.

Query Parameters

integer
default:1
Page number for pagination (1-indexed). Must be a positive integer.
integer
default:20
Number of results to return per page. Must be between 1 and 100.
string
Filter projects by their current status. Omit to return all projects.Allowed values:
  • generating - Video scenes are being generated
  • post_processing - Generating voiceover and lip sync
  • stitching - Combining scenes with audio and captions
  • completed - Project is ready with final video
  • failed - Generation encountered an unrecoverable error
  • partial - Some scenes completed but project failed overall

Response

array
List of project objects matching the query criteria.
object
Pagination metadata for navigating through results.

Example Requests

Example Response

Notes

Security: Only projects belonging to the authenticated user are returned. API keys are scoped to individual user accounts.
Video Availability: The final_output_url is only populated when the project status is completed. For projects still in progress, this field will be null.
Sorting: Results are always sorted by created_at in descending order (newest projects first). Custom sorting is not currently supported.
Rate Limiting: This endpoint is rate-limited to 60 requests per minute per API key. See Rate Limits for details.