REST API ReferenceEndpointsProjects

Get project metadata

Returns a simplified view of a project including its title, aspect ratio, status, and URL.

Authentication

AuthorizationBearer
API key from [app.videogen.io/api](https://app.videogen.io/api). The full key is only shown once when you create it.

Path parameters

projectIdstringRequired

The project id (e.g. vg_proj_...).

Response

Project metadata.
projectIdstring

Opaque project id (e.g. vg_proj_...).

assistantIdstring or null

Opaque id of this project’s assistant conversation (e.g. vg_asst_...). Use with the Assistant API to send follow-up messages or list the assistant’s prior messages for this project. null for older projects created before assistant chats were attached at creation time.

titlestring
aspectRatioobject

Aspect ratio as a width:height pair (e.g. 16 and 9 for 16:9). Not pixel dimensions.

statusenum

High-level project status.

createdAtinteger

Seconds since epoch (Unix timestamp) when the project was created.

updatedAtinteger

Seconds since epoch (Unix timestamp) when the project was last updated.

projectUrlstringformat: "uri"

Deep link to open this project in the VideoGen web editor. Not required for an API-only integration: store projectId and use the Projects API (export, remix, metadata). Use projectUrl when a person should open the project in the app to review or edit it manually. The project is visible only to members of your team and any project collaborators, the same access model as a project created in the dashboard.