> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.videogen.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.videogen.io/_mcp/server.

# Get project metadata

GET https://api.videogen.io/v1/projects/{projectId}

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

Reference: https://docs.videogen.io/rest-api-reference/projects/get-project

## Authentication

- `Authorization` header (bearer token, required) — API key from [app.videogen.io/api](https://app.videogen.io/api). The full key is only shown once when you create it.

## Request

### Path parameters

- `projectId` (string, required) — The project id (e.g. `vg_proj_...`).

## Response

### 200

Project metadata.

- `projectId` (string, required) — Opaque project id (e.g. `vg_proj_...`).
- `assistantId` (string, required, nullable) — 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.
- `title` (string, required)
- `aspectRatio` (AspectRatio, required) — Aspect ratio as a width:height pair (e.g. 16 and 9 for 16:9). Not pixel dimensions.
- `status` (enum, required) — High-level project status.
  - Allowed values: `generating`, `ready`
- `createdAt` (integer, required) — Seconds since epoch (Unix timestamp) when the project was created.
- `updatedAt` (integer, required) — Seconds since epoch (Unix timestamp) when the project was last updated.
- `projectUrl` (string, required) — 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.

## Types

### AspectRatio

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

- `width` (integer, required)
- `height` (integer, required)

## Examples

**Response**

```json
{
  "projectId": "vg_proj_9dTk3mQ1rZ7xP4vN2sB6wc",
  "title": "Staying hydrated",
  "aspectRatio": {
    "width": 16,
    "height": 9
  },
  "status": "ready",
  "createdAt": 1779537600,
  "updatedAt": 1779537870,
  "projectUrl": "https://app.videogen.io/project/1f0a2b3c-4d5e-6789-ab12-cdef34567890"
}
```

**SDK Code**

```typescript
import { VideoGen } from "@videogen/sdk";

const client = new VideoGen({ apiKey: "sk_videogen_live_..." });

await client.projects.getProject({
  projectId: "vg_proj_9dTk3mQ1rZ7xP4vN2sB6wc",
});
```

```python
from videogen import VideoGen

client = VideoGen(api_key="sk_videogen_live_...")

client.projects.get_project(
    project_id="vg_proj_9dTk3mQ1rZ7xP4vN2sB6wc",
)
```