> For the complete documentation index, see [llms.txt](https://diffio.ai/llms.txt). This page is also available as HTML at https://diffio.ai/docs/api-reference/get-project/.

# Get a project

Returns one project, including its upload `status`, probed `duration_seconds` and `has_video`, active `share_id`, and `latest_generation`.

GET `https://api.diffio.ai/v2/projects/{project_id}`

- Key scope: `projects:read`
- Auth header: `Authorization: Bearer <apiKey>`
- Body: None

## Request

Pass `project_id` in the path; takes no request body.

### Path parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `project_id` | string | Yes | Unique identifier of the project. |

### Headers

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Diffio-End-User` | string | No | Optional end-user identifier (up to 128 characters). Scopes the request to that end user's projects; omit to act across the whole account. |

## Example request

**Python**

```python
import os
from diffio import DiffioClient

key = os.environ["DIFFIO_API_KEY"]
client = DiffioClient(api_key=key)

project = client.projects.get(
    "62f62565-049f-5e7e-bbd2-9de0cf7ddbfe",
)
```

**Node.js**

```javascript
import { DiffioClient } from "diffio"

const client = new DiffioClient({
  apiKey: process.env.DIFFIO_API_KEY,
})

const project = await client.projects.get(
  "62f62565-049f-5e7e-bbd2-9de0cf7ddbfe",
)
```

**cURL**

```bash
curl "https://api.diffio.ai/v2/projects/62f62565-049f-5e7e-bbd2-9de0cf7ddbfe" \
  -H "Authorization: Bearer $DIFFIO_API_KEY"
```

## Response

Returns the `project` object.

Success: `200`

### Response fields

| Field | Type | Present | Description |
| --- | --- | --- | --- |
| `id` | string | Always | Unique project identifier (UUID). |
| `object` | string | Always | Resource type, always `"project"`. |
| `status` | string | Always | Upload and preparation state: `awaiting_upload` until bytes arrive, `preparing` while media is probed, `ready` when ready to restore, or `failed`. |
| `file_name` | string \| null | Always | Recording filename as sent at creation, or `null`. |
| `content_type` | string \| null | Always | MIME type sent at creation (`application/octet-stream` when none was sent), or `null`. |
| `size_bytes` | integer \| null | Always | File size in bytes: the uploaded byte count once the upload arrives, before that the `size_bytes` sent at creation; `null` when unknown. |
| `duration_seconds` | number \| null | Always | Recording duration in seconds once `status` is `ready`, or `null` while awaiting upload or preparing. |
| `has_video` | boolean | Always | True when the recording has video: inferred from `content_type` or the file name until the upload is probed, then from the file itself. |
| `end_user` | string \| null | Always | End-user identifier from the `Diffio-End-User` header at creation, or `null` for account-level projects. |
| `metadata` | object | Always | Key-value string map saved with the project (`{}` when none was supplied). |
| `generation_count` | integer | Always | Total number of generations created for this project. |
| `video_preview_status` | string \| null | Always | State of a video project's picture-only HLS stream (`video_hls`): `preparing`, `ready`, or `failed`; `null` for audio projects. |
| `share_id` | string \| null | Always | Public 17-character share identifier while a share is published, or `null` when unshared. |
| `latest_generation` | object \| null | Always | Newest `Generation` object on this project, or `null` when no generation exists yet. |
| `created_at` | string \| null | Always | ISO 8601 UTC timestamp when the project was created, or `null`. |
| `updated_at` | string \| null | Always | ISO 8601 UTC timestamp when the project last changed, or `null`. |
| `error` | object \| null | Always | Failure details when `status` is `failed`, or `null` otherwise. |
| `error.code` | string | Always | Stable `snake_case` project failure code (`media_processing_failed` or `project_failed`). |
| `error.message` | string | Always | Human-readable explanation of why the upload could not be prepared. |

## Example response (200)

**Successful response**

```json
{
  "id": "62f62565-049f-5e7e-bbd2-9de0cf7ddbfe",
  "object": "project",
  "status": "awaiting_upload",
  "file_name": "interview.mp3",
  "content_type": "audio/mpeg",
  "size_bytes": 510957,
  "duration_seconds": null,
  "has_video": false,
  "end_user": "customer-mwe8tm1g",
  "metadata": {
    "order_id": "1042"
  },
  "generation_count": 0,
  "video_preview_status": null,
  "latest_generation": null,
  "share_id": null,
  "created_at": "2026-11-13T00:33:21.812909Z",
  "updated_at": "2026-11-13T00:33:21.812909Z",
  "error": null
}
```

## Return codes

- `200` Returns the requested project.
- `400` `Diffio-End-User` exceeds 128 characters. [`invalid_header`](https://diffio.ai/docs/api-reference/errors/#invalid_header)
- `403` Key is inactive or lacks `projects:read`. [`permission_denied`](https://diffio.ai/docs/api-reference/errors/#permission_denied)
- `404` No project with that `project_id` exists for this account and end user. [`project_not_found`](https://diffio.ai/docs/api-reference/errors/#project_not_found)
- **`401` `405` Same on every endpoint**

  - `401` Missing API key (code missing_api_key), or invalid API key (code invalid_api_key).
  - `405` HTTP method not supported on this path; check the Allow header (code method_not_allowed).

### Example error response

Errors are JSON: an `error` object with `code`, `message` and `request_id`. An unrecognized key returns `401`:

**Error response**

```json
{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key.",
    "request_id": "dead773b60e148fd9e22d680a22fa701"
  }
}
```

## Notes

- `status` transitions from `awaiting_upload` to `preparing` to `ready` (or `failed` with `error` if the uploaded file cannot be decoded).
- Once `status` is `ready`, `duration_seconds` and `has_video` reflect the probed file; `size_bytes` is the uploaded byte count from when the upload arrives.
- Upload credentials are not returned here; call [Get new upload instructions](https://diffio.ai/docs/api-reference/reopen-project-upload/) if an upload has not arrived yet.

## Related pages

- Previous: [List projects](https://diffio.ai/docs/api-reference/list-projects/): List projects on the account newest first with cursor pagination.
- Next: [Delete a project](https://diffio.ai/docs/api-reference/delete-project/): Delete a project and all of its stored uploads, generations, exports, and shares.

- [Full API guide](https://diffio.ai/docs/developers/full-api-guide/): Every topic, limit and concept in one index.
- [Diffio API overview](https://diffio.ai/api-overview/): The cloud batch workflow and SDKs on one page.
